{"items":[{"type":"link","label":"Wise Platform API","link":"/api-reference","routeSlug":"/api-reference","content":{"contentType":"overview","meta":{"name":"Wise Platform API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/api-reference/@latest/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/api-reference/@latest/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Wise Platform API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Wise Platform API is a REST-based interface that enables programmatic access to Wise's payment infrastructure. All endpoints return JSON-formatted responses and use standard HTTP methods and status codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"success","name":"New to wise?"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We strongly recommend first reading our "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started Guide"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to help you set up credentials and make your first call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-2":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you begin "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this API reference effectively, you should have:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Received Valid "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API credentials from Wise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Client ID and Client Secret)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understand OAuth 2.0 authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be familiar with RESTful API concepts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-2":true,"m-t-5":true,"m-b-0":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Core API resources "},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate and fee calculations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary account management"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment creation and execution"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/balance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-currency account operations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account ownership details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/rate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current and historical exchange rates"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"m-t-3":true,"m-b-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not sure which workflow to build?"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start with our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/use-cases"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for step-by-step implementation examples."},"children":[]}]}]}]}],"sectionId":"/api-reference"}],"sectionId":"/api-reference"}]}]}},{"type":"separator","label":"Authentication","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"oauthTokenCreate","name":"Create an OAuth token","isWebhook":false,"pointer":"/paths/~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an OAuth token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange credentials or authorisation grants for an OAuth 2.0 access token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines which parameters are required and which response fields are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token#managing-token-expiration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"managing token expiration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for guidance on refreshing tokens before they expire."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication using your Client ID and Client Secret as the username and password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials are provided by Wise when your partnership begins. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1oauth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_622"}},"schemaId":"schema_622","pointer":"/paths/~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth/token","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"","x-defaultPassword":""}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_622"}},"responseCodes":["200","400","401","429"],"pointer":"/oauth/token","href":"oauth-token/oauthtokencreate","openApiOperationId":"oauthTokenCreate","summary":"Create an OAuth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_622","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_622"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token-response"}},"schemaId":"components/schemas/token-response","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}},"schemaId":"schema_624","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Invalid credentials. For example, the user reclaimed the account or an invalid registration code was used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}},"schemaId":"schema_625","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/token-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token-response"}}},{"code":"400","schemaId":"schema_624","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}}},{"code":"401","schemaId":"schema_625","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/oauth-token/oauthtokencreate"}],"panels":[]}]},"httpPath":"/oauth/token"}],"content":{"contentType":"group","meta":{"name":"oauth-token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OAuth Token","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange client credentials or authorisation grants for OAuth 2.0 access tokens. All grant types use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with basic authentication (your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the grant type, this endpoint issues either a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client credentials token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials token "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An application-level token for requests that aren't tied to a specific Wise user, such as generating un-authenticated quotes and subscribing to application webhooks. Valid for 12 hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the only grant type for this token."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User token "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token for making API calls on behalf of a specific Wise user, such as creating transfers and managing balances. Access tokens are valid for 12 hours and can be refreshed using a refresh token. Grant types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for partners that create Wise users via API. Exchanges a registration code for a user access token and refresh token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for partners using the OAuth redirect flow. Exchanges an authorisation code for a user access token and refresh token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — obtain a new user access token without requiring the user to re-authorise."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"managing-token-expiration","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing token expiration "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours. You can request a new access token whenever it's close to expiring — there is no need to wait for the actual expiration to happen first. Depending on how your application uses the Wise Platform API, requesting a new access token before attempting a series of API calls on behalf of an individual user will avoid issues with expired access tokens."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth/token","summary":"Create an OAuth token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/oauth-token/oauthtokencreate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Enhanced Security","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"joseResponsePublicKeysGet","name":"Get Wise JOSE public key","isWebhook":false,"pointer":"/paths/~1auth~1jose~1response~1public-keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Wise JOSE public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a public key issued by Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the scope requested, the key will be used for verifying HTTP responses signed by Wise or for for encrypting the payload prior to sending it to Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For both signature verification and payload encryption, the process involves storing this public key after retrieval. In both cases, the stored public key should be used without calling this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If verification of the signed request fails or Wise is unable to decrypt your request payload, call this API to issue a fresh key from Wise and reattempt the operation again."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint requires a client credentials token, not a user level access token. Make sure you use your client details to fetch a valid "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client credentials token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before performing this call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_628","description":"Fetch a specific public key version. If omitted the most recent public key is provided."},{"name":"algorithm","in":"query","schemaId":"schema_629","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Algorithm to be used for signature verification or payload encryption. This must match the algorithm used during request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature verification (Scope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_SIGNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES384"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES512"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS384"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS512"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload encryption (Scope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_ENCRYPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RSA_OAEP_256"},"children":[]}]}]}]}],"required":true,"example":"ES512"},{"name":"scope","in":"query","schemaId":"schema_630","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope of the key. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_SIGNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_ENCRYPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"PAYLOAD_SIGNING"}],"pointer":"/paths/~1auth~1jose~1response~1public-keys/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1response~1public-keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/jose/response/public-keys","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"version","in":"query","required":false,"schemaId":"schema_628"},{"name":"algorithm","in":"query","required":true,"example":"ES512","schemaId":"schema_629"},{"name":"scope","in":"query","required":true,"example":"PAYLOAD_SIGNING","schemaId":"schema_630"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/auth/jose/response/public-keys","href":"jose/joseresponsepublickeysget","openApiOperationId":"joseResponsePublicKeysGet","summary":"Get Wise JOSE public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Public key object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631","exampleIds":["paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_631","exampleIds":["paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1response~1public-keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_631","exampleIds":["paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631","exampleIds":["paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseresponsepublickeysget"}],"panels":[]}]},"httpPath":"/auth/jose/response/public-keys"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"joseRequestPublicKeysCreate","name":"Add a new client public key","isWebhook":false,"pointer":"/paths/~1auth~1jose~1request~1public-keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new client public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a client public key for request payload signing or response payload encryption."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint requires a client credentials token, not a user level access token. Make sure you use your client details to fetch a valid "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client credentials token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before performing this call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1request~1public-keys/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_632","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1auth~1jose~1request~1public-keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/jose/request/public-keys","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_632","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","429"],"pointer":"/auth/jose/request/public-keys","href":"jose/joserequestpublickeyscreate","openApiOperationId":"joseRequestPublicKeysCreate","summary":"Add a new client public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_632","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Public key created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_633","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1request~1public-keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_633","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633","exampleIds":["paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joserequestpublickeyscreate"}],"panels":[]}]},"httpPath":"/auth/jose/request/public-keys"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"josePlaygroundJws","name":"Playground JWS","isWebhook":false,"pointer":"/paths/~1auth~1jose~1playground~1jws/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playground JWS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_634","required":true,"example":"application/jose+json"},{"name":"x-tw-jose-method","in":"header","schemaId":"schema_635","description":"JOSE method identifier.","required":true,"example":"jws"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1playground~1jws/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_636","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_636","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1auth~1jose~1playground~1jws/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/jose/playground/jws","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/jose+json","schemaId":"schema_634"},{"name":"x-tw-jose-method","in":"header","required":true,"example":"jws","schemaId":"schema_635"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_636","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","429"],"pointer":"/auth/jose/playground/jws","href":"jose/joseplaygroundjws","openApiOperationId":"josePlaygroundJws","summary":"Playground JWS"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -i -X POST \\\n https://api.wise-sandbox.com/v1/auth/jose/playground/jws \\\n -H 'Accept: application/jose+json' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'x-tw-jose-method: jws' \\\n -d 'eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsInVybCI6Ii92MS9hdXRoL2pvc2UvcGxheWdyb3VuZC9qd3MifQ.eyJtZXNzYWdlIjoiVGhpcyBpcyBhbiBleGFtcGxlIGZyb20gZG9jcy53aXNlLmNvbSJ9.AS9QHdkWvUEn0LxQEMPRBzlceN78J-Le-Qm1XIkkSBpsGdc0WM0MZTIGFEAJEcWeUR2M-abtd5DRdar4hLzs9apPAQ-GT70SIDV6pX9-4UKfIfzJ4g305zCoHflTfn-ijvI7XrVR_yr7xO9GJo86bfBqAX_m5uuxyU7Jy9gM1epd8HcC'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_636","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_636","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Signed response.","mediaType":"application/jose+json","mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_637","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example"]}},"schemaId":"schema_637","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1playground~1jws/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_637","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_637","exampleIds":["paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseplaygroundjws"}],"panels":[]}]},"httpPath":"/auth/jose/playground/jws"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"josePlaygroundJweGet","name":"Playground JWE for GET requests","isWebhook":false,"pointer":"/paths/~1auth~1jose~1playground~1jwe/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playground JWE for GET requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send test HTTP GET requests and receive encrypted responses.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_634","required":true,"example":"application/jose+json"},{"name":"x-tw-jose-method","in":"header","schemaId":"schema_638","description":"JOSE method identifier.","required":true,"example":"jwe"},{"name":"x-tw-jose-encryption-kid","in":"header","schemaId":"schema_639","description":"Public Key ID of JWE Encryption Key","required":true,"example":"2333836d-2e1c-4acd-8b52-234d379260aa"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/jose/playground/jwe","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/jose+json","schemaId":"schema_634"},{"name":"x-tw-jose-method","in":"header","required":true,"example":"jwe","schemaId":"schema_638"},{"name":"x-tw-jose-encryption-kid","in":"header","required":true,"example":"2333836d-2e1c-4acd-8b52-234d379260aa","schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/auth/jose/playground/jwe","href":"jose/joseplaygroundjweget","openApiOperationId":"josePlaygroundJweGet","summary":"Playground JWE for GET requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Encrypted response.","mediaType":"application/jose+json","mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_640","exampleIds":["paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example"]}},"schemaId":"schema_640","exampleIds":["paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_640","exampleIds":["paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_640","exampleIds":["paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseplaygroundjweget"}],"panels":[]}]},"httpPath":"/auth/jose/playground/jwe"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"josePlaygroundJwePost","name":"Playground JWE for POST requests","isWebhook":false,"pointer":"/paths/~1auth~1jose~1playground~1jwe/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playground JWE for POST requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_634","required":true,"example":"application/jose+json"},{"name":"x-tw-jose-method","in":"header","schemaId":"schema_638","description":"JOSE method identifier.","required":true,"example":"jwe"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_641","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_641","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1auth~1jose~1playground~1jwe/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/jose/playground/jwe","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/jose+json","schemaId":"schema_634"},{"name":"x-tw-jose-method","in":"header","required":true,"example":"jwe","schemaId":"schema_638"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_641","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","429"],"pointer":"/auth/jose/playground/jwe","href":"jose/joseplaygroundjwepost","openApiOperationId":"josePlaygroundJwePost","summary":"Playground JWE for POST requests"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -i -X POST \\\n https://api.wise-sandbox.com/v1/auth/jose/playground/jwe \\\n -H 'Accept: application/jose+json' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'x-tw-jose-method: jwe' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W_WPBDXclMryaywqAB-_yC1hUYukKmZxByhE9d1G8hClc2HpewkryILGJW4uVTUeRdo1oVWd68TPIqi7bqMGUsrT-3MI4ggVSjC1rf8Lf1xTZ8-GHjSPso8tFBXnydOKzggi6fnfk98BIW76Rnxkn6sW79LH5NgN1spTOoh8-tI3i_wbHdqJOxTReaUNMYZobm7wxedZcRxhsaSrVqx2qdELeqkfwgvB1DRbHTF_PTe4W0ibMbcJivHjiDf6oAV9vXgVhYb66rhB43pgdFDv4nY1mkQC45R5T6CBdzv80EdAVOj1G4bktHyJWaJzHVsGozpxsNj3bt1AopyvDO8tsw.WLOO5WH4ZpBPi-8B.0g3eUpQPvRIaTbgUi6sH0WejsJ1nLWDGnDKTktZrkquLQlCMmIguj0I5UCyqXEo.URtTniRvfGxrKRLK63trug'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_641","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_641","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Encrypted response.","mediaType":"application/jose+json","mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_642","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example"]}},"schemaId":"schema_642","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_642","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_642","exampleIds":["paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseplaygroundjwepost"}],"panels":[]}]},"httpPath":"/auth/jose/playground/jwe"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"josePlaygroundJweDirectEncryption","name":"Playground JWE for direct encryption","isWebhook":false,"pointer":"/paths/~1auth~1jose~1playground~1jwe-direct-encryption/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playground JWE for direct encryption","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_634","required":true,"example":"application/jose+json"},{"name":"x-tw-jose-method","in":"header","schemaId":"schema_638","description":"JOSE method identifier.","required":true,"example":"jwe"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_643","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_643","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/jose/playground/jwe-direct-encryption","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/jose+json","schemaId":"schema_634"},{"name":"x-tw-jose-method","in":"header","required":true,"example":"jwe","schemaId":"schema_638"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_643","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","429"],"pointer":"/auth/jose/playground/jwe-direct-encryption","href":"jose/joseplaygroundjwedirectencryption","openApiOperationId":"josePlaygroundJweDirectEncryption","summary":"Playground JWE for direct encryption"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -i -X POST \\\n https://api.wise-sandbox.com/v1/auth/jose/playground/jwe-direct-encryption \\\n -H 'Accept: application/jose+json' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'x-tw-jose-method: jwe' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.rVqOhX92u637hqwrw96rqA48e7NhMZVeWvUZwA4OAwOa_sBVcpXecd6qivPfZ-CuhRaD4gNKUlUJnTedBwOh5hcDZELRWThtwNiTZKaDS_ZNDjJf1r0VQPj65nT2ikfPAP-S6cYCy6JbWXivf7Jwq6lus-QydmxoLlVRvAuROFe-HzlH0-JhlwOdhPwbwl1AGx64qEir7oOn5VezJvpx3sscipm3w30mfoFc7pLlscMijMNFUwngXCLmgpno1rC_ZDzRcEycVbwvgKW75jO25UyEJif25MdE0UJUx4IT6MDviHqtBXO4OQpwhd_W6jVk-PlZ1WkZyOZqpi8HLKGo8Q.eFHqPV-mcBC82Ga2.W9o2BT7Q-vEUA2u3n4gaSdfQY_4svVj0-jwjcXmlBraZEKmtTW_A1ygvr8b9iHfS9fkxL8H_6S_oEcqzFqTKmNTzwe2V0cRY-kvzsKI.lO2gETmo2WocPZoTpU-pkQ'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_643","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_643","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Encrypted response using direct encryption.","mediaType":"application/jose+json","mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_644","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example"]}},"schemaId":"schema_644","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_644","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_644","exampleIds":["paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseplaygroundjwedirectencryption"}],"panels":[]}]},"httpPath":"/auth/jose/playground/jwe-direct-encryption"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"josePlaygroundJwsJwe","name":"Playground JWS+JWE","isWebhook":false,"pointer":"/paths/~1auth~1jose~1playground~1jwsjwe/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Playground JWS+JWE","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flow combines both JWS and JWE:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sign payload (JWS) → Encrypt signed JWT (JWE) → Send to Wise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Receive encrypted response → Decrypt (JWE) → Verify signature (JWS)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":""},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the Wise API returns a generic 500 Internal Server Error for decryption failures across endpoints using JWE and JWS+JWE. For example, an invalid key can cause a decryption failure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our team is currently planning improvements for these types of error messages to make them more specific and clear. Thank you for your patience."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_634","required":true,"example":"application/jose+json"},{"name":"x-tw-jose-method","in":"header","schemaId":"schema_645","description":"JOSE method identifier.","required":true,"example":"jws+jwe"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_646","description":"Disables response compression so the encrypted response can be processed correctly.","example":"identity"},{"name":"X-TW-JOSE-Encryption-kid","in":"header","schemaId":"schema_647","description":"ID of the public JWE key uploaded to Wise for encrypting the response.","required":true,"example":"2333836d-2e1c-4acd-8b52-234d379260aa"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1auth~1jose~1playground~1jwsjwe/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_648","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_648","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/jose/playground/jwsjwe","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/jose+json","schemaId":"schema_634"},{"name":"x-tw-jose-method","in":"header","required":true,"example":"jws+jwe","schemaId":"schema_645"},{"name":"Accept-Encoding","in":"header","required":false,"example":"identity","schemaId":"schema_646"},{"name":"X-TW-JOSE-Encryption-kid","in":"header","required":true,"example":"2333836d-2e1c-4acd-8b52-234d379260aa","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_648","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","400","429","500"],"pointer":"/auth/jose/playground/jwsjwe","href":"jose/joseplaygroundjwsjwe","openApiOperationId":"josePlaygroundJwsJwe","summary":"Playground JWS+JWE"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -i -X POST \\\n https://api.wise-sandbox.com/v1/auth/jose/playground/jwsjwe \\\n -H 'Accept: application/jose+json' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'x-tw-jose-method: jws+jwe' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcxWwgtjEPkOnLdVNyH9ncZi5Y9xQbjD4sYJn8vEQmxKHDw5s14sWhdexSNAPTVMSyzwJaA-LRL0tZTEuQ.ohD4LLjImiKOV4Tu.Rgp9mc2JD6m9Zm5htSqrejwWYy0_hIylYdLD39ZCR-VnQ2VX-Tot8kKGeNncnv7hJ_ApANWiJpKJbiM.5hNt-uaxuOkOraGGZSmsig'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_648","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_648","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Signed and encrypted response.","mediaType":"application/jose+json","mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_649","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example"]}},"schemaId":"schema_649","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError"]}},"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError"]}},"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1auth~1jose~1playground~1jwsjwe/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_649","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeContent":{"application/jose+json":{"schemaId":"schema_649","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example"]}}},{"code":"400","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jose/joseplaygroundjwsjwe"}],"panels":[]}]},"httpPath":"/auth/jose/playground/jwsjwe"}],"content":{"contentType":"group","meta":{"name":"jose"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"JOSE","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise uses the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jose.readthedocs.io/en/latest/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JOSE framework"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept and respond with signed and encrypted payloads. These endpoints allow you to manage keys and test your signing and encryption implementation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, please speak with your Implementation team."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/jose/response/public-keys","summary":"Get Wise JOSE public key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jose/joseresponsepublickeysget","deprecated":false},{"title":"/auth/jose/request/public-keys","summary":"Add a new client public key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jose/joserequestpublickeyscreate","deprecated":false},{"title":"/auth/jose/playground/jws","summary":"Playground JWS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jose/joseplaygroundjws","deprecated":false},{"title":"/auth/jose/playground/jwe","summary":"Playground JWE for GET requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jose/joseplaygroundjweget","deprecated":false},{"title":"/auth/jose/playground/jwe","summary":"Playground JWE for POST requests","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jose/joseplaygroundjwepost","deprecated":false},{"title":"/auth/jose/playground/jwe-direct-encryption","summary":"Playground JWE for direct encryption","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jose/joseplaygroundjwedirectencryption","deprecated":false},{"title":"/auth/jose/playground/jwsjwe","summary":"Playground JWS+JWE","prefix":{"name":"post","color":"post"},"badges":[],"link":"/jose/joseplaygroundjwsjwe","deprecated":false}]}]}]}]}},{"type":"separator","label":"Users","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"user"},"seo":{"title":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/user"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userGetByToken","name":"Retrieve current user by token","isWebhook":false,"pointer":"/paths/~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve current user by token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get authenticated user details for the user's token submitted in the Authorization header.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1me/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/me","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/me","href":"user/usergetbytoken","openApiOperationId":"userGetByToken","summary":"Retrieve current user by token","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}},"schemaId":"components/schemas/user","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usergetbytoken"}],"panels":[]}]},"httpPath":"/me"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userGetById","name":"Retrieve a user by ID","isWebhook":false,"pointer":"/paths/~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a user by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get authenticated user details by user ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_650","description":"The user ID.","required":true,"example":101}],"pointer":"/paths/~1users~1{userId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":101,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/users/{userId}","href":"user/usergetbyid","openApiOperationId":"userGetById","summary":"Retrieve a user by ID","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}},"schemaId":"components/schemas/user","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usergetbyid"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userCreate","name":"Create a user with a registration code","isWebhook":false,"pointer":"/paths/~1user~1signup~1registration_code/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user with a registration code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Wise uses email address as unique identifier for users. If email is new (there is no active user already) then a new user will be created.\n\nWhen you are submitting an email which already exists amongst our users then you will get a warning that \"You're already a member. Please login\". If user already exists then you need to redirect to \"Get user authorization\" webpage.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1user~1signup~1registration_code/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_651"}},"schemaId":"schema_651","pointer":"/paths/~1user~1signup~1registration_code/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/signup/registration_code","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_651"}},"responseCodes":["200","409","429"],"pointer":"/user/signup/registration_code","href":"user/usercreate","openApiOperationId":"userCreate","summary":"Create a user with a registration code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_651","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_651"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - User is created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/user","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"Conflict - User already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_652","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1user~1signup~1registration_code/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_652","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652","exampleIds":["paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usercreate"}],"panels":[]}]},"httpPath":"/user/signup/registration_code"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userCheckExists","name":"Check if user exists","isWebhook":false,"pointer":"/paths/~1users~1exists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check if user exists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this uses a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client-credentials-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and not a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for authentication."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1users~1exists/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_653"}},"schemaId":"schema_653","pointer":"/paths/~1users~1exists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/exists","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_653"}},"responseCodes":["200","429"],"pointer":"/users/exists","href":"user/usercheckexists","openApiOperationId":"userCheckExists","summary":"Check if user exists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_653","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_653"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully checked user existence.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_654","exampleIds":["paths/~1users~1exists/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_654","exampleIds":["paths/~1users~1exists/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1users~1exists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_654","exampleIds":["paths/~1users~1exists/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_654","exampleIds":["paths/~1users~1exists/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usercheckexists"}],"panels":[]}]},"httpPath":"/users/exists"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userContactEmailSet","name":"Set a contact email address","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1contact-email/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a contact email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets a contact email address. The contact email address is used to send notifications to users who have been registered with a dummy email address.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_650","description":"The user ID.","required":true,"example":101}],"pointer":"/paths/~1users~1{userId}~1contact-email/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1users~1{userId}~1contact-email/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_655"}},"schemaId":"schema_655","pointer":"/paths/~1users~1{userId}~1contact-email/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{userId}/contact-email","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":101,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_655"}},"responseCodes":["200","429"],"pointer":"/users/{userId}/contact-email","href":"user/usercontactemailset","openApiOperationId":"userContactEmailSet","summary":"Set a contact email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_655","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_655"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Contact email address set successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1users~1{userId}~1contact-email/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usercontactemailset"}],"panels":[]}]},"httpPath":"/users/{userId}/contact-email"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userContactEmailGet","name":"Retrieve a contact email address","isWebhook":false,"pointer":"/paths/~1users~1{userId}~1contact-email/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a contact email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a contact email address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_650","description":"The user ID.","required":true,"example":101}],"pointer":"/paths/~1users~1{userId}~1contact-email/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1users~1{userId}~1contact-email/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}/contact-email","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":101,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/users/{userId}/contact-email","href":"user/usercontactemailget","openApiOperationId":"userContactEmailGet","summary":"Retrieve a contact email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved contact email address.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1users~1{userId}~1contact-email/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656","exampleIds":["paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/usercontactemailget"}],"panels":[]}]},"httpPath":"/users/{userId}/contact-email"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventUsersStateChange","name":"User state change","isWebhook":true,"pointer":"/paths/users#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a user's state is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User state change transitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user's account is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITHDRAW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user has 90 calendar days to remove their money from their balance before we fully close their account. This can be done through sending from their balance to themselves and others or spending with their card. The user still cannot order new cards, convert between balances, open and close balances, and download balance statements. After 90 calendar days, the account moves into a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user's account is deactivated and they cannot perform any actions on their account. The end-user tokens are revoked and you will receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for API calls."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/user-deactivation-flow.7df75a5ba10e3faef9629533e54c5d5bf332b6c3f0f622344408bf97a717b7b0.28b10c14.png","alt":"User state change flow diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/users#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658","pointer":"/paths/users#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"users#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_658"}},"responseCodes":["200"],"pointer":"users#state-change","href":"user/eventusersstatechange","openApiOperationId":"eventUsersStateChange","summary":"User state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_658"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/users#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/eventusersstatechange"}],"panels":[]}]},"httpPath":"users#state-change"}],"content":{"contentType":"group","meta":{"name":"user"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A User serves as the primary entity and can possess multiple Profiles to represent different contexts or settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A User can have one personal Profile and multiple business Profiles."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — whether personal or business — can have its own "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/multi-currency-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multi-currency account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabling transactions across various currencies. This hierarchical structure allows for flexible management of user settings and financial operations,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accommodating both personal and business needs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"User profile structure","src":"/assets/user-profile-structure.865aa0b1c6662d0c57c5915f762819df314ce48f990a2e7a63e695f3e89062bb.28b10c14.svg"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"User","link":"/user/user","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/me","summary":"Retrieve current user by token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/usergetbytoken","deprecated":false},{"title":"/users/{userId}","summary":"Retrieve a user by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/usergetbyid","deprecated":false},{"title":"/user/signup/registration_code","summary":"Create a user with a registration code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/usercreate","deprecated":false},{"title":"/users/exists","summary":"Check if user exists","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/usercheckexists","deprecated":false},{"title":"/users/{userId}/contact-email","summary":"Set a contact email address","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user/usercontactemailset","deprecated":false},{"title":"/users/{userId}/contact-email","summary":"Retrieve a contact email address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/usercontactemailget","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"users#state-change","summary":"User state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/eventusersstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"claimAccountCreate","name":"Generate a claim account code","isWebhook":false,"pointer":"/paths/~1user~1claim-account/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a claim account code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a short-lived "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"claim_account_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that allows a customer to take ownership of an account. Use the code when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/redirect-to-wise/claim-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirecting the customer to Wise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to finalize their account setup."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1user~1claim-account/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_660","exampleIds":["paths/~1user~1claim-account/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_660","exampleIds":["paths/~1user~1claim-account/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1user~1claim-account/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/claim-account","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_660","exampleIds":["paths/~1user~1claim-account/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/user/claim-account","href":"claim-account/claimaccountcreate","openApiOperationId":"claimAccountCreate","summary":"Generate a claim account code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_660","exampleIds":["paths/~1user~1claim-account/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_660","exampleIds":["paths/~1user~1claim-account/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Claim account code generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_661","exampleIds":["paths/~1user~1claim-account/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_661","exampleIds":["paths/~1user~1claim-account/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1user~1claim-account/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_661","exampleIds":["paths/~1user~1claim-account/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_661","exampleIds":["paths/~1user~1claim-account/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/claim-account/claimaccountcreate"}],"panels":[]}]},"httpPath":"/user/claim-account"}],"content":{"contentType":"group","meta":{"name":"claim-account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Claim Account","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow a customer to take ownership of an account "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/user/usercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created on their behalf"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Generate a short-lived "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"claim_account_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use it when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/redirect-to-wise/claim-account"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirecting the customer to Wise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to finalize their account setup."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user/claim-account","summary":"Generate a claim account code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/claim-account/claimaccountcreate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Profiles","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"profile"},"seo":{"title":"Profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/profile"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileList","name":"List profiles for a user account","isWebhook":false,"pointer":"/paths/~1profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List profiles for a user account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of all profiles belonging to user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles","href":"profile/profilelist","openApiOperationId":"profileList","summary":"List profiles for a user account","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of profile objects. Note that there might be more than one business profile returned in the response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662","exampleIds":["paths/~1profiles/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_662","exampleIds":["paths/~1profiles/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_662","exampleIds":["paths/~1profiles/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662","exampleIds":["paths/~1profiles/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilelist"}],"panels":[]}]},"httpPath":"/profiles"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profilePersonalCreate","name":"Create a personal profile","isWebhook":false,"pointer":"/paths/~1profiles~1personal-profile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a personal profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a personal profile for the authenticated user. A personal profile represents an individual and is required before creating transfers or business profiles."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-idempotence-uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to safely retry requests. If omitted and a profile already exists, the API returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can then retrieve existing profiles via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profilelist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List profiles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-4":true,"m-t-3":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field notes "},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First and last names"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are limited to 30 characters each. Truncate if necessary (e.g. when a customer has many middle names)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"occupations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for CA, IN, JP, ID, IL, MX, and within the US for the state NM."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactDetails"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used for mandatory customer notifications and to help identify your customer when contacting Wise support."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-idempotence-uuid","in":"header","schemaId":"schema_647","description":"Unique idempotency key for the request."},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1personal-profile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_663"}},"schemaId":"schema_663","pointer":"/paths/~1profiles~1personal-profile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/personal-profile","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-idempotence-uuid","in":"header","required":false,"schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_663"}},"responseCodes":["200","429"],"pointer":"/profiles/personal-profile","href":"profile/profilepersonalcreate","openApiOperationId":"profilePersonalCreate","summary":"Create a personal profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_663","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_663"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created personal profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_664"}},"schemaId":"schema_664","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1personal-profile/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_664","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_664"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilepersonalcreate"}],"panels":[]}]},"httpPath":"/profiles/personal-profile"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileBusinessCreateV5","name":"Create a business profile","isWebhook":false,"pointer":"/paths/~1profiles~1business-profile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a business profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates the business profile and its authorized representative in a single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request accepts an optional field in the header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-idempotence-uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This should be unique for each Profile you create. In the event that the request fails, you should use the same value again when retrying. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-idempotence-uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is not provided and a Profile already exists, then you will receive a response with an HTTP status code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"industryCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/migrate-business-profile-industry-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migrating to industry categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you are moving from a previous version of this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-idempotence-uuid","in":"header","schemaId":"schema_647","description":"Unique idempotency key for the request."},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1business-profile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665","exampleIds":["paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails","paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"]}},"schemaId":"schema_665","exampleIds":["paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails","paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"],"pointer":"/paths/~1profiles~1business-profile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/business-profile","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-idempotence-uuid","in":"header","required":false,"schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_665","exampleIds":["paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails","paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"]}},"responseCodes":["200","429"],"pointer":"/profiles/business-profile","href":"profile/profilebusinesscreatev5","openApiOperationId":"profileBusinessCreateV5","summary":"Create a business profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_665","exampleIds":["paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails","paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665","exampleIds":["paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails","paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/business-profile-industry-categories"}},"schemaId":"components/schemas/business-profile-industry-categories","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1business-profile/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/business-profile-industry-categories","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/business-profile-industry-categories"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilebusinesscreatev5"}],"panels":[]}]},"httpPath":"/profiles/business-profile"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileGet","name":"Retrieve a profile by ID","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a profile by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get profile info by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}","href":"profile/profileget","openApiOperationId":"profileGet","summary":"Retrieve a profile by ID","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Profile object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/profile"}},"schemaId":"components/schemas/profile","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/profile"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profilePersonalUpdate","name":"Update a personal profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1personal-profile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a personal profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update user profile information for a personal profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If user profile has been verified then there are restrictions on what information is allowed to change. Where permitted, use the update window functionality by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profileupdatewindowopen"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"opening the update window"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", submitting the updated information using this endpoint, and finally "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profileupdatewindowclose"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"closing the update window"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Personal profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1personal-profile/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1personal-profile/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_666"}},"schemaId":"schema_666","pointer":"/paths/~1profiles~1{profileId}~1personal-profile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/personal-profile","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_666"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/personal-profile","href":"profile/profilepersonalupdate","openApiOperationId":"profilePersonalUpdate","summary":"Update a personal profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_666","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_666"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated personal profile.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1personal-profile/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilepersonalupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/personal-profile"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileBusinessUpdateV3","name":"Update a business profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1business-profile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a business profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update user profile information for a business profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If user profile has been verified then there are restrictions on what information is allowed to change."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where permitted, use the update window functionality by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profileupdatewindowopen"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"opening the update window"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", submitting the updated information using this endpoint, and finally "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profileupdatewindowclose"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"closing the update window"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"industryCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/migrate-business-profile-industry-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migrating to industry categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you are moving from a previous version of this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_667"}},"schemaId":"schema_667","pointer":"/paths/~1profiles~1{profileId}~1business-profile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/business-profile","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_667"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/business-profile","href":"profile/profilebusinessupdatev3","openApiOperationId":"profileBusinessUpdateV3","summary":"Update a business profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_667","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_667"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/business-profile-industry-categories"}},"schemaId":"components/schemas/business-profile-industry-categories","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/business-profile-industry-categories","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/business-profile-industry-categories"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilebusinessupdatev3"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/business-profile"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileBusinessRepresentativeGet","name":"Retrieve business representative","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve business representative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Business Representative info by Business Profile ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/business-profile/business-representative","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/business-profile/business-representative","href":"profile/profilebusinessrepresentativeget","openApiOperationId":"profileBusinessRepresentativeGet","summary":"Retrieve business representative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Business representative object.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilebusinessrepresentativeget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/business-profile/business-representative"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileBusinessRepresentativeUpdate","name":"Update business representative","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update business representative","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update or transfer the Business Representative for the specified Business Profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updateContext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update the existing Business Representative's details, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_OF_AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to transfer authority of the Business Profile to a new Business Representative."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Business Representative has been verified then there are restrictions on what information is allowed to change."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this Business Representative is shared across multiple Business Profiles, then changes will be reflected for all of the Business Profiles."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_OF_AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this will overwrite the existing Business Representative. The new Business Representative will need to be verified for KYC purposes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_668","exampleIds":["paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails","paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"]}},"schemaId":"schema_668","exampleIds":["paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails","paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/business-profile/business-representative","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_668","exampleIds":["paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails","paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/business-profile/business-representative","href":"profile/profilebusinessrepresentativeupdate","openApiOperationId":"profileBusinessRepresentativeUpdate","summary":"Update business representative"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_668","exampleIds":["paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails","paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_668","exampleIds":["paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails","paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Business representative updated successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profilebusinessrepresentativeupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/business-profile/business-representative"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileVerificationDocumentCreate","name":"Create an identification document","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an identification document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an identification document to a personal profile. Not applicable to business profiles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For SSN submissions, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (9 digits, no letters or symbols) are required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"]}},"schemaId":"schema_669","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/verification-documents","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"]}},"responseCodes":["200","422","429"],"pointer":"/profiles/{profileId}/verification-documents","href":"profile/profileverificationdocumentcreate","openApiOperationId":"profileVerificationDocumentCreate","summary":"Create an identification document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_669","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_669","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj","paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identification document created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_670"}},"schemaId":"schema_670","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request could not be processed due to a missing prerequisite."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when submitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_CAPACITY_BR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a profile that has no tax ID on record."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}},"schemaId":"schema_671","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_670","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_670"}}},{"code":"422","schemaId":"schema_671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileverificationdocumentcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/verification-documents"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileVerificationDocumentUpdate","name":"Update an identification document","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an identification document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing identification document on a personal profile. Not\napplicable to business profiles.\n\nThis endpoint performs a full replacement of the document details. Any\nfields not provided in the request body will be set to null on the stored\ndocument. Partners must provide all fields they wish to retain. \n\nOnly partners with a KYC partner onboarding model\nare permitted to use this endpoint. Non-KYC partners will receive a 400 error.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_672","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"]}},"schemaId":"schema_672","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/verification-documents","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_672","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"]}},"responseCodes":["200","400","422","429"],"pointer":"/profiles/{profileId}/verification-documents","href":"profile/profileverificationdocumentupdate","openApiOperationId":"profileVerificationDocumentUpdate","summary":"Update an identification document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_672","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_672","exampleIds":["paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard","paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identification document updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_670"}},"schemaId":"schema_670","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error. Possible error codes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not.allowed.for.clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Partner is not found or is not a KYC"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not.allowed.for.uniqueIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Document number exceeds maximum"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"length (30 characters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotNull"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A required field ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is missing."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_673"}},"schemaId":"schema_673","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request could not be processed due to a missing prerequisite."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when submitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_CAPACITY_BR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a profile that has no tax ID on record."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}},"schemaId":"schema_671","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-documents/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_670","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_670"}}},{"code":"400","schemaId":"schema_673","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_673"}}},{"code":"422","schemaId":"schema_671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileverificationdocumentupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/verification-documents"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileDirectorCreate","name":"Create business directors","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1directors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create business directors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds new directors to the business profile.\n\nReturns the list of all directors associated with the business profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1directors/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1directors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/directors","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/directors","href":"profile/profiledirectorcreate","openApiOperationId":"profileDirectorCreate","summary":"Create business directors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all directors associated with the business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profiledirectorcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/directors"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileDirectorList","name":"List business directors","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1directors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List business directors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of director objects associated with the business profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1directors/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/directors","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/directors","href":"profile/profiledirectorlist","openApiOperationId":"profileDirectorList","summary":"List business directors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of director objects.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profiledirectorlist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/directors"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileDirectorUpdate","name":"Update business directors","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1directors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update business directors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Overrides directors in the business profile.\n\nReturns the list of all directors associated with the business profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1directors/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1directors/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/directors","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/directors","href":"profile/profiledirectorupdate","openApiOperationId":"profileDirectorUpdate","summary":"Update business directors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all directors associated with the business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1directors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675","exampleIds":["paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profiledirectorupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/directors"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileUboCreate","name":"Create business ultimate owners","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1ubos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create business ultimate owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds new ultimate beneficial owners to the business profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of all ultimate beneficial owners associated with the business profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the shareholders that have at least 25% ownership should be submitted via this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that in some cases, we do not require the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ownershipPercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In these cases, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be passed as the value."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"]}},"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"],"pointer":"/paths/~1profiles~1{profileId}~1ubos/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/ubos","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/ubos","href":"profile/profileubocreate","openApiOperationId":"profileUboCreate","summary":"Create business ultimate owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all ultimate beneficial owners associated with the business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileubocreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/ubos"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileUboList","name":"List business ultimate owners","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1ubos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List business ultimate owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of all ultimate beneficial owners associated with the business profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/ubos","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/ubos","href":"profile/profileubolist","openApiOperationId":"profileUboList","summary":"List business ultimate owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ultimate beneficial owner objects.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileubolist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/ubos"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileUboUpdate","name":"Update business ultimate owners","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1ubos/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update business ultimate owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Overrides ultimate beneficial owners in the business profile.\n\nReturns the list of all ultimate beneficial owners associated with the business profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Business profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"]}},"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"],"pointer":"/paths/~1profiles~1{profileId}~1ubos/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{profileId}/ubos","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/ubos","href":"profile/profileuboupdate","openApiOperationId":"profileUboUpdate","summary":"Update business ultimate owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all ultimate beneficial owners associated with the business profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1ubos/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677","exampleIds":["paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileuboupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/ubos"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileUpdateWindowOpen","name":"Open an update window","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1update-window/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Open an update window","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Opens the update window for updating the profile information: details, addresses, directors, owners, others.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/update-window","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/update-window","href":"profile/profileupdatewindowopen","openApiOperationId":"profileUpdateWindowOpen","summary":"Open an update window"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Update window opened successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileupdatewindowopen"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/update-window"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileUpdateWindowClose","name":"Close an update window","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1update-window/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close an update window","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the update window for updating the profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/update-window","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/update-window","href":"profile/profileupdatewindowclose","openApiOperationId":"profileUpdateWindowClose","summary":"Close an update window"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Update window closed successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1update-window/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileupdatewindowclose"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/update-window"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"profileVerificationStatusCheck","name":"Check profile verification status","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check profile verification status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can check the verification status of a profile using this API. This is a profile-specific API resource which should be accessed using an access token acquired for the profile.\n\nWe do not expose any finer details of customer verification.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source_currencies","in":"query","schemaId":"schema_639","description":"Comma-separated list of ISO 4217 currency codes.","required":true,"example":"GBP,USD,EUR"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/verification-status/bank-transfer","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"source_currencies","in":"query","required":true,"example":"GBP,USD,EUR","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/verification-status/bank-transfer","href":"profile/profileverificationstatuscheck","openApiOperationId":"profileVerificationStatusCheck","summary":"Check profile verification status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification status response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_678","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_678","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_678","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_678","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/profileverificationstatuscheck"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/verification-status/bank-transfer"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesOverdraftLimitThreshold","name":"Overdraft limit threshold","isWebhook":true,"pointer":"/paths/profiles#overdraft-limit-threshold/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Overdraft limit threshold","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#overdraft-limit-threshold"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#overdraft-limit-threshold/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_679"}},"schemaId":"schema_679","pointer":"/paths/profiles#overdraft-limit-threshold/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#overdraft-limit-threshold","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_679"}},"responseCodes":["200"],"pointer":"profiles#overdraft-limit-threshold","href":"profile/eventprofilesoverdraftlimitthreshold","openApiOperationId":"eventProfilesOverdraftLimitThreshold","summary":"Overdraft limit threshold"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_679","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_679"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#overdraft-limit-threshold/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/eventprofilesoverdraftlimitthreshold"}],"panels":[]}]},"httpPath":"profiles#overdraft-limit-threshold"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesStateChange","name":"Profile state change","isWebhook":true,"pointer":"/paths/profiles#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a profile's state is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"schemaId":"schema_680","pointer":"/paths/profiles#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_680"}},"responseCodes":["200"],"pointer":"profiles#state-change","href":"profile/eventprofilesstatechange","openApiOperationId":"eventProfilesStateChange","summary":"Profile state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_680","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/eventprofilesstatechange"}],"panels":[]}]},"httpPath":"profiles#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesVerificationStateChange","name":"Verification state change","isWebhook":true,"pointer":"/paths/profiles#verification-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the verification state of a connected profile changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A profile's "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the user is ready to make payments using Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then we advise not to initiate any transfers with the user's access token as the payments will not be processed until the verification is completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#verification-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#verification-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_681"}},"schemaId":"schema_681","pointer":"/paths/profiles#verification-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#verification-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_681"}},"responseCodes":["200"],"pointer":"profiles#verification-state-change","href":"profile/eventprofilesverificationstatechange","openApiOperationId":"eventProfilesVerificationStateChange","summary":"Verification state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_681","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_681"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#verification-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/eventprofilesverificationstatechange"}],"panels":[]}]},"httpPath":"profiles#verification-state-change"}],"content":{"contentType":"group","meta":{"name":"profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profiles","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A profile represents an identity that can send and receive money through Wise — either a personal profile (an individual) or a business profile (a company). Most API endpoints require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, which is the ID of either profile type."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Profile","link":"/profile/profile","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles","summary":"List profiles for a user account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/profilelist","deprecated":false},{"title":"/profiles/personal-profile","summary":"Create a personal profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profilepersonalcreate","deprecated":false},{"title":"/profiles/business-profile","summary":"Create a business profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profilebusinesscreatev5","deprecated":false},{"title":"/profiles/{profileId}","summary":"Retrieve a profile by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/profileget","deprecated":false},{"title":"/profiles/{profileId}/personal-profile","summary":"Update a personal profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profilepersonalupdate","deprecated":false},{"title":"/profiles/{profileId}/business-profile","summary":"Update a business profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profilebusinessupdatev3","deprecated":false},{"title":"/profiles/{profileId}/business-profile/business-representative","summary":"Retrieve business representative","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/profilebusinessrepresentativeget","deprecated":false},{"title":"/profiles/{profileId}/business-profile/business-representative","summary":"Update business representative","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profilebusinessrepresentativeupdate","deprecated":false},{"title":"/profiles/{profileId}/verification-documents","summary":"Create an identification document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profileverificationdocumentcreate","deprecated":false},{"title":"/profiles/{profileId}/verification-documents","summary":"Update an identification document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profileverificationdocumentupdate","deprecated":false},{"title":"/profiles/{profileId}/directors","summary":"Create business directors","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profiledirectorcreate","deprecated":false},{"title":"/profiles/{profileId}/directors","summary":"List business directors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/profiledirectorlist","deprecated":false},{"title":"/profiles/{profileId}/directors","summary":"Update business directors","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profiledirectorupdate","deprecated":false},{"title":"/profiles/{profileId}/ubos","summary":"Create business ultimate owners","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profileubocreate","deprecated":false},{"title":"/profiles/{profileId}/ubos","summary":"List business ultimate owners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/profileubolist","deprecated":false},{"title":"/profiles/{profileId}/ubos","summary":"Update business ultimate owners","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/profileuboupdate","deprecated":false},{"title":"/profiles/{profileId}/update-window","summary":"Open an update window","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profileupdatewindowopen","deprecated":false},{"title":"/profiles/{profileId}/update-window","summary":"Close an update window","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profile/profileupdatewindowclose","deprecated":false},{"title":"/profiles/{profileId}/verification-status/bank-transfer","summary":"Check profile verification status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/profileverificationstatuscheck","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"profiles#overdraft-limit-threshold","summary":"Overdraft limit threshold","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/eventprofilesoverdraftlimitthreshold","deprecated":false},{"title":"profiles#state-change","summary":"Profile state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/eventprofilesstatechange","deprecated":false},{"title":"profiles#verification-state-change","summary":"Verification state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/eventprofilesverificationstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activityList","name":"List Activities for a Profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Activities for a Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of activities belonging to user profile.\n\nActivities represent snapshots of performed actions and can be filtered by various parameters to narrow down the results.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The unique identifier of the profile.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1activities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"monetaryResourceType","in":"query","schemaId":"schema_682","description":"Filter activity by resource type."},{"name":"status","in":"query","schemaId":"schema_683","description":"Filter by activity status."},{"name":"since","in":"query","schemaId":"schema_684","description":"Filter activity list after a certain timestamp. Use ISO 8601 format."},{"name":"until","in":"query","schemaId":"schema_685","description":"Filter activity list until a certain timestamp. Use ISO 8601 format."},{"name":"nextCursor","in":"query","schemaId":"schema_686","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination cursor returned from a previous response. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the response to fetch the next page of activities."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_687","description":"Desired size of query. Min 1, max 100, and default value is 10 if not specified."}],"pointer":"/paths/~1profiles~1{profileId}~1activities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/activities","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"monetaryResourceType","in":"query","required":false,"example":"TRANSFER","schemaId":"components/schemas/ActivityResourceType"},{"name":"status","in":"query","required":false,"example":"IN_PROGRESS","schemaId":"components/schemas/ActivityStatus"},{"name":"since","in":"query","required":false,"example":"2025-03-10T11:56:30.376Z","schemaId":"schema_684"},{"name":"until","in":"query","required":false,"example":"2025-03-30T23:59:59.999Z","schemaId":"schema_685"},{"name":"nextCursor","in":"query","required":false,"example":"","schemaId":"schema_686"},{"name":"size","in":"query","required":false,"schemaId":"schema_687"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/activities","href":"activity/activitylist","openApiOperationId":"activityList","summary":"List Activities for a Profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved activities.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688","exampleIds":["paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_688","exampleIds":["paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_688","exampleIds":["paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688","exampleIds":["paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/activitylist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/activities"}],"content":{"contentType":"group","meta":{"name":"activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity","showPageActions":true},{"nodeType":"markdoc","content":"Activity represents a snapshot of a performed action for a profile."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/activities","summary":"List Activities for a Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity/activitylist","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Address"},"seo":{"title":"Address"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Address","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Address"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressCreate","name":"Create or Update an Address","isWebhook":false,"pointer":"/paths/~1addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Update an Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds address info to user profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of required fields are different for different countries. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/addressRequirementsGet"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address requirements endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to dynamically discover required fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For updating personal profiles, consider using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profilepersonalupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the personal profile update endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. It allows submitting the address information alongside other profile data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for US, CA, BR, and AU addresses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for CA, IN, JP, ID, IL, MX, and within the US for the state NM."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1addresses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressRequest"}},"schemaId":"components/schemas/AddressRequest","pointer":"/paths/~1addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addresses","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressRequest"}},"responseCodes":["200","429"],"pointer":"/addresses","href":"address/addresscreate","openApiOperationId":"addressCreate","summary":"Create or Update an Address","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/AddressRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Address successfully created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1addresses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/addresscreate"}],"panels":[]}]},"httpPath":"/addresses"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressList","name":"List Addresses for a Profile","isWebhook":false,"pointer":"/paths/~1addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Addresses for a Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of addresses belonging to user profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"profile","in":"query","schemaId":"schema_650","description":"The profile ID to list addresses for.","example":12345678}],"pointer":"/paths/~1addresses/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"profile","in":"query","example":12345678,"schemaId":"schema_650"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/addresses","href":"address/addresslist","openApiOperationId":"addressList","summary":"List Addresses for a Profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved addresses.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689","exampleIds":["paths/~1addresses/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_689","exampleIds":["paths/~1addresses/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1addresses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_689","exampleIds":["paths/~1addresses/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689","exampleIds":["paths/~1addresses/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/addresslist"}],"panels":[]}]},"httpPath":"/addresses"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressGet","name":"Retrieve an Address by ID","isWebhook":false,"pointer":"/paths/~1addresses~1{addressId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Address by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get address info by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addressId","in":"path","schemaId":"schema_650","description":"The unique identifier of the address.","required":true}],"pointer":"/paths/~1addresses~1{addressId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1addresses~1{addressId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addresses/{addressId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"addressId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/addresses/{addressId}","href":"address/addressget","openApiOperationId":"addressGet","summary":"Retrieve an Address by ID","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved the address.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1addresses~1{addressId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Address","exampleIds":["paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/addressget"}],"panels":[]}]},"httpPath":"/addresses/{addressId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressRequirementsGet","name":"Get Address Requirements","isWebhook":false,"pointer":"/paths/~1address-requirements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Address Requirements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains 4 required top-level fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (select field with list of values)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (text field)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (text field)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (text field)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a field has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refreshRequirementsOnChange: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", call the POST endpoint with that field's value to discover additional required fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a step-by-step walkthrough, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/address-requirements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address Requirements guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1address-requirements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/address-requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/address-requirements","href":"address/addressrequirementsget","openApiOperationId":"addressRequirementsGet","summary":"Get Address Requirements","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved address requirements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressRequirementsResponse"}},"schemaId":"components/schemas/AddressRequirementsResponse","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1address-requirements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressRequirementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressRequirementsResponse"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/addressrequirementsget"}],"panels":[]}]},"httpPath":"/address-requirements"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addressRequirementsPost","name":"Get Address Requirements (with context)","isWebhook":false,"pointer":"/paths/~1address-requirements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Address Requirements (with context)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of fields required to create a valid address, based on the provided context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to dynamically discover additional required fields based on selected values. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"details\": {\"country\": \"US\"}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will add \"state\" to the list of fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"details\": {\"country\": \"CA\"}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will add \"occupations\" to the list of fields."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continue calling this endpoint with field values until all fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refreshRequirementsOnChange: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have been populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a step-by-step walkthrough, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/address-requirements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address Requirements guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1address-requirements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressRequirementsRequest","exampleIds":["paths/~1address-requirements/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AddressRequirementsRequest","exampleIds":["paths/~1address-requirements/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1address-requirements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/address-requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddressRequirementsRequest","exampleIds":["paths/~1address-requirements/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/address-requirements","href":"address/addressrequirementspost","openApiOperationId":"addressRequirementsPost","summary":"Get Address Requirements (with context)","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/AddressRequirementsRequest","exampleIds":["paths/~1address-requirements/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddressRequirementsRequest","exampleIds":["paths/~1address-requirements/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved address requirements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressRequirementsResponse"}},"schemaId":"components/schemas/AddressRequirementsResponse","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1address-requirements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddressRequirementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddressRequirementsResponse"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/address/addressrequirementspost"}],"panels":[]}]},"httpPath":"/address-requirements"}],"content":{"contentType":"group","meta":{"name":"address"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Addresses","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage physical addresses associated with user profiles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address requirements vary by country — use the address requirements endpoints to dynamically discover which fields are needed before creating an address."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Address","link":"/address/address","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addresses","summary":"Create or Update an Address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address/addresscreate","deprecated":false},{"title":"/addresses","summary":"List Addresses for a Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/addresslist","deprecated":false},{"title":"/addresses/{addressId}","summary":"Retrieve an Address by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/addressget","deprecated":false},{"title":"/address-requirements","summary":"Get Address Requirements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/address/addressrequirementsget","deprecated":false},{"title":"/address-requirements","summary":"Get Address Requirements (with context)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/address/addressrequirementspost","deprecated":false}]}]}]}]}},{"type":"separator","label":"Verification","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"kyc-requirement"},"seo":{"title":"KYC Requirement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Requirement","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/kyc-requirement"},"children":[]}]}]}},{"type":"link","label":"KYC Review","link":"/api-reference/kyc-review/kyc-review","routeSlug":"/api-reference/kyc-review/kyc-review","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"kyc-review"},"seo":{"title":"KYC Review"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Review","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/kyc-review"},"children":[]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"kyc-review-with-link"},"seo":{"title":"KYC Review with a Hosted KYC link"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Review with a Hosted KYC link","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/kyc-review-with-link"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewCreate","name":"Create a KYC Review","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a KYC Review","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a KYC Review for a specific customer action.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"schemaId":"schema_690","pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/kyc-reviews","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_690"}},"responseCodes":["202","400","401","404","429"],"pointer":"/profiles/{profileId}/kyc-reviews","href":"kyc-review/kycreviewcreate","openApiOperationId":"kycReviewCreate","summary":"Create a KYC Review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_690","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"KYC Review successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review"}},"schemaId":"components/schemas/kyc-review","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (e.g. unsupported "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", null "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Underlying action with provided ID is not found (e.g. quote not found).","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/kyc-review","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/kycreviewcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/kyc-reviews"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewList","name":"Get all KYC Reviews for a profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all KYC Reviews for a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all active KYC Reviews for a given profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_691","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_692","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired number of items per page. Max "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/kyc-reviews","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"pageNumber","in":"query","required":false,"schemaId":"schema_691"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_692"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","429"],"pointer":"/profiles/{profileId}/kyc-reviews","href":"kyc-review/kycreviewlist","openApiOperationId":"kycReviewList","summary":"Get all KYC Reviews for a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of KYC Review objects for the profile. Returns an empty list if no KYC Review exists for the profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_693"}},"schemaId":"schema_693","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_693","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_693"}}},{"code":"401"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/kycreviewlist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/kyc-reviews"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewGet","name":"Get KYC Review by ID","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get KYC Review by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single KYC Review by ID for a profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The KYC Review ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","429"],"pointer":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","href":"kyc-review/kycreviewget","openApiOperationId":"kycReviewGet","summary":"Get KYC Review by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the KYC Review object including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requirements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review"}},"schemaId":"components/schemas/kyc-review","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"KYC Review not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/kyc-review","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review"}}},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/kycreviewget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/kyc-reviews/{kycReviewId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewRedirectUrlUpdate","name":"Update KYC Review to get a Hosted KYC link","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update KYC Review to get a Hosted KYC link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the KYC Review with a redirect URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the KYC Review object with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field containing a URL where the end customer needs to be directed in order to complete the Hosted KYC flow. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The link is short-lived and single-use and valid for 5 minutes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the response to determine the exact expiry time. To regenerate the link, call this endpoint again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the Hosted KYC flow is completed by the end customer, they will be redirected to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in this API call. During the redirection, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be appended with query parameters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The KYC Review ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_694"}},"schemaId":"schema_694","pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_694"}},"responseCodes":["200","400","401","404","429"],"pointer":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","href":"kyc-review/kycreviewredirecturlupdate","openApiOperationId":"kycReviewRedirectUrlUpdate","summary":"Update KYC Review to get a Hosted KYC link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_694","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_694"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the updated KYC Review object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review-with-link"}},"schemaId":"components/schemas/kyc-review-with-link","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request (e.g. not a valid URI).","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"KYC Review not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/kyc-review-with-link","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kyc-review-with-link"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/kycreviewredirecturlupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/kyc-reviews/{kycReviewId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewRequirementSubmit","name":"Submit a KYC Requirement","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a KYC Requirement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a KYC requirement for a KYC Review."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A KYC requirement can only be submitted if the KYC Review status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_CUSTOMER_INPUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A KYC requirement should only be submitted if its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiCollectionSupported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/kyc-requirement-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for the full list of supported requirement types, submission data structures, and accepted values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"requirementKey","in":"path","schemaId":"schema_695","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KYC requirement type to submit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/kyc-requirement-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for details on each type."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_696","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"]}},"schemaId":"schema_696","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"],"pointer":"/paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/kyc-requirements/{requirementKey}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"requirementKey","in":"path","required":true,"schemaId":"schema_695"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_696","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"]}},"responseCodes":["202","400","401","404","429"],"pointer":"/profiles/{profileId}/kyc-requirements/{requirementKey}","href":"kyc-review/kycreviewrequirementsubmit","openApiOperationId":"kycReviewRequirementSubmit","summary":"Submit a KYC Requirement"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \\\n 'https://api.wise-sandbox.com/v2/profiles/{profileId}/kyc-requirements/{requirementKey}' \\\n -H 'Authorization: Bearer ' \\\n -F 'submissionData={\"data\":{\"accountPurpose\":\"SENDING_MONEY_TO_FRIENDS_OR_FAMILY\"},\"version\":\"V1\",\"kycReviewId\":\"93a903ea-636c-4c86-a25c-cf6d2bd00e81\"};type=application/json' \\\n -F 'files=@\"\"'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_696","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_696","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"KYC requirement successfully submitted.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Common error scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kycReviewId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in submission data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided in submission data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid field values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing required files"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true"]}},"schemaId":"schema_697","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"KYC Review or provided requirement key not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"schema_697","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697","exampleIds":["paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required","paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true"]}}},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/kycreviewrequirementsubmit"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/kyc-requirements/{requirementKey}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventKycReviewsStateChange","name":"KYC review state change","isWebhook":true,"pointer":"/paths/kyc-reviews#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC review state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a KYC review state has changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In previous versions, this event fired only when the overall KYC review state changed. In "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v5.0.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it fires on every requirement or additional requirement state change, which may result in receiving more events. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.prevState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.requirementChanges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on what changed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kyc-reviews#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/kyc-reviews#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"schemaId":"schema_698","pointer":"/paths/kyc-reviews#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-reviews#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_698"}},"responseCodes":["200"],"pointer":"kyc-reviews#state-change","href":"kyc-review/eventkycreviewsstatechange","openApiOperationId":"eventKycReviewsStateChange","summary":"KYC review state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_698","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/kyc-reviews#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kyc-review/eventkycreviewsstatechange"}],"panels":[]}]},"httpPath":"kyc-reviews#state-change"}],"content":{"contentType":"group","meta":{"name":"kyc-review"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC Review","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Review API provides endpoints to view, update and submit information related to the KYC flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two ways to collect KYC requirements from your customers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted KYC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — redirect your customer to a Wise-hosted UI that guides them through the process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API submission"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to submit requirements directly. This is only available for requirement types where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiCollectionSupported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted KYC guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on the general use of the endpoints included below."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"KYC Requirement","link":"/kyc-review/kyc-requirement","deprecated":false},{"title":"KYC Review","link":"/kyc-review/kyc-review","deprecated":false},{"title":"KYC Review with a Hosted KYC link","link":"/kyc-review/kyc-review-with-link","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/kyc-reviews","summary":"Create a KYC Review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-review/kycreviewcreate","deprecated":false},{"title":"/profiles/{profileId}/kyc-reviews","summary":"Get all KYC Reviews for a profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-review/kycreviewlist","deprecated":false},{"title":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","summary":"Get KYC Review by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kyc-review/kycreviewget","deprecated":false},{"title":"/profiles/{profileId}/kyc-reviews/{kycReviewId}","summary":"Update KYC Review to get a Hosted KYC link","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/kyc-review/kycreviewredirecturlupdate","deprecated":false},{"title":"/profiles/{profileId}/kyc-requirements/{requirementKey}","summary":"Submit a KYC Requirement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-review/kycreviewrequirementsubmit","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"kyc-reviews#state-change","summary":"KYC review state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kyc-review/eventkycreviewsstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verificationUploadEvidences","name":"Upload Evidences","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Evidences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads verification evidence for a specific profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body varies significantly between "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" profiles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitting an evidence that was already uploaded will result in an attempt to update the evidence."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The unique identifier of the profile.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_699"}},"schemaId":"schema_699","pointer":"/paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/additional-verification/upload-evidences","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_699"}},"responseCodes":["207","400","403","429"],"pointer":"/profiles/{profileId}/additional-verification/upload-evidences","href":"verification/verificationuploadevidences","openApiOperationId":"verificationUploadEvidences","summary":"Upload Evidences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_699","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_699"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"207","description":"Multi-Status - Evidence(s) successfully uploaded, fully or partially.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700","exampleIds":["paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success","paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess"]}},"schemaId":"schema_700","exampleIds":["paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success","paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad Request - Invalid request payload (e.g. no evidence, misspelled evidence, unexpected value).","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden - The client is not authorized to perform this request.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"207","schemaId":"schema_700","exampleIds":["paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success","paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700","exampleIds":["paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success","paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess"]}}},{"code":"400"},{"code":"403"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification/verificationuploadevidences"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/additional-verification/upload-evidences"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verificationUploadDocument","name":"Upload Document","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1upload-document/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads verification documents for review. You can upload multiple files at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid document must fulfil these requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document must be clear."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The document needs to be a .jpg, .png., or .pdf file type up to 10MB in size."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1upload-document/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1upload-document/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_701"}},"schemaId":"schema_701","pointer":"/paths/~1profiles~1{profileId}~1verification-status~1upload-document/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/verification-status/upload-document","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_701"}},"responseCodes":["204","400","403","409","413","415","429"],"pointer":"/profiles/{profileId}/verification-status/upload-document","href":"verification/verificationuploaddocument","openApiOperationId":"verificationUploadDocument","summary":"Upload Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_701","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_701"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - Document successfully uploaded.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad Request - Document cannot be uploaded in the current format. Check file size and extension.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden - The client is not authorized to perform this request.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"Conflict - Document is already uploaded and cannot be re-submitted before review.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"413","description":"Payload Too Large - Requested file size is too large.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"415","description":"Unsupported Media Type - Request payload is in an unsupported format.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1upload-document/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400"},{"code":"403"},{"code":"409"},{"code":"413"},{"code":"415"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification/verificationuploaddocument"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/verification-status/upload-document"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verificationGetRequiredEvidences","name":"Required Evidences","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Required Evidences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches the required evidences for a profile to complete additional customer verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one or more evidences are returned, the customer should submit those evidences using the upload-evidences endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Evidences guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the list of possible evidence types and how to submit them."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The unique identifier of the profile.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/verification-status/required-evidences","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","403","429"],"pointer":"/profiles/{profileId}/verification-status/required-evidences","href":"verification/verificationgetrequiredevidences","openApiOperationId":"verificationGetRequiredEvidences","summary":"Required Evidences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved required evidences.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_702","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden - The client is not authorized to perform this request.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_702","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702","exampleIds":["paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example"]}}},{"code":"403"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification/verificationgetrequiredevidences"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/verification-status/required-evidences"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesCddCheckStateChange","name":"Additional verification state change","isWebhook":true,"pointer":"/paths/profiles#cdd-check-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Additional verification state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event pushes updates for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Customer Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#cdd-check-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/verification-state-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/verification-state-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification state values"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFIED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional verification check has passed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVIDENCE_REQUIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional verification check has failed, evidences are required ."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/review-outcome-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/review-outcome-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review outcome values"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_POOR_QUALITY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document quality poor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_OUT_OF_DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document out of date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_NAME_MISMATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name on document does not match records."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_NAME"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name on document missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_ISSUE_DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document issue date missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_COMPANY_LOGO_LETTERHEAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company logo or letterhead missing from document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_NOT_COMPLETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document is partially cut-off and does not contain full information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document missing signature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_INCOME"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document missing income information or income is not clear from the document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_TYPE_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitted document type is not acceptable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVOICE_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice is not an accepted document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_ID_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Photo ID is not an accepted document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSACTION_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction (or a screenshot of a transaction) is not accepted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Photos (or computer screenshots) are not acceptable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason unknown."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/required-evidence-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/required-evidence-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required evidence values"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of evidences"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find all possible values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#cdd-check-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"schemaId":"schema_703","pointer":"/paths/profiles#cdd-check-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#cdd-check-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_703"}},"responseCodes":["200"],"pointer":"profiles#cdd-check-state-change","href":"verification/eventprofilescddcheckstatechange","openApiOperationId":"eventProfilesCddCheckStateChange","summary":"Additional verification state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_703","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#cdd-check-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification/eventprofilescddcheckstatechange"}],"panels":[]}]},"httpPath":"profiles#cdd-check-state-change"}],"content":{"contentType":"group","meta":{"name":"verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Additional Verification","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is being deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/api-hybrid-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC review endpoints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify your customers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In certain situations, additional evidence is required to verify customers and ensure we’re compliant with the KYC regulations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Verification APIs support a list of evidences that can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Evidences guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer Account with Partner KYC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" model and your customers are primarily based in the EU,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refer to this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification#onboarding-eu-customers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding EU customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for instructions on how to use these APIs."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/additional-verification/upload-evidences","summary":"Upload Evidences","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification/verificationuploadevidences","deprecated":false},{"title":"/profiles/{profileId}/verification-status/upload-document","summary":"Upload Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification/verificationuploaddocument","deprecated":false},{"title":"/profiles/{profileId}/verification-status/required-evidences","summary":"Required Evidences","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification/verificationgetrequiredevidences","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"profiles#cdd-check-state-change","summary":"Additional verification state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification/eventprofilescddcheckstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"facetecPublicKeyGet","name":"Get FaceTec public key","isWebhook":false,"pointer":"/paths/~1facetec~1public-key/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get FaceTec public key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Wise's FaceTec public key to be used when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.facetec.com/api-guide#export-3d-facemap"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exporting 3D FaceMap"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from your FaceTec host to Wise."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1facetec~1public-key/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/facetec/public-key","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/facetec/public-key","href":"facetec/facetecpublickeyget","openApiOperationId":"facetecPublicKeyGet","summary":"Get FaceTec public key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plain text containing the public key.","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_639","exampleIds":["paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example"]}},"schemaId":"schema_639","exampleIds":["paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1facetec~1public-key/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_639","exampleIds":["paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_639","exampleIds":["paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facetec/facetecpublickeyget"}],"panels":[]}]},"httpPath":"/facetec/public-key"}],"content":{"contentType":"group","meta":{"name":"facetec"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FaceTec","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise leverages "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.facetec.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FaceTec's"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" facial biometric technology for authentication. Use this endpoint to retrieve the public key needed for exporting 3D FaceMaps."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/facetec/public-key","summary":"Get FaceTec public key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facetec/facetecpublickeyget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Embedded Flows","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientEmbeddedLinkRequestCreate","name":"Recipient creation","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a link that allows a user to complete a recipient creation flow via either a redirect or embedded iframe/webview."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/recipient-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - Recipient Creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see what data the frontend is returned upon flow completion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_704","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_704","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/embedded-flows/link-requests/recipients","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_704","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","404","429"],"pointer":"/profiles/{profileId}/embedded-flows/link-requests/recipients","href":"link-requests/recipientembeddedlinkrequestcreate","openApiOperationId":"recipientEmbeddedLinkRequestCreate","summary":"Recipient creation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_704","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_704","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Embedded link request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request, such as an invalid redirect URL.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Profile not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/link-requests/recipientembeddedlinkrequestcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/recipients"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paymentInstrumentEmbeddedLinkRequestCreate","name":"Payment instrument creation","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment instrument creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a link that allows a user to complete a payment instrument flow via either a redirect or embedded iframe/webview."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/payment-instrument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - Payment Instruments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see what data the frontend is returned upon flow completion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_706","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_706","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/embedded-flows/link-requests/payment-instrument","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_706","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","404","429"],"pointer":"/profiles/{profileId}/embedded-flows/link-requests/payment-instrument","href":"link-requests/paymentinstrumentembeddedlinkrequestcreate","openApiOperationId":"paymentInstrumentEmbeddedLinkRequestCreate","summary":"Payment instrument creation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_706","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_706","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Embedded link request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request, such as an invalid redirect URL.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Profile not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/link-requests/paymentinstrumentembeddedlinkrequestcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/payment-instrument"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kycReviewsEmbeddedLinkRequestCreate","name":"KYC review completion","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC review completion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a link that allows a user to complete a KYC review flow via either a redirect or embedded iframe/webview."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/kyc-reviews"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - KYC Review"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see what data the frontend is returned upon flow completion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_707","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_707","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/embedded-flows/link-requests/kyc-reviews","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_707","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","404","429"],"pointer":"/profiles/{profileId}/embedded-flows/link-requests/kyc-reviews","href":"link-requests/kycreviewsembeddedlinkrequestcreate","openApiOperationId":"kycReviewsEmbeddedLinkRequestCreate","summary":"KYC review completion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_707","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_707","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Embedded link request created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request, such as an invalid redirect URL.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Profile not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705","exampleIds":["paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/link-requests/kycreviewsembeddedlinkrequestcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/embedded-flows/link-requests/kyc-reviews"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"embeddedLinkRequestGet","name":"Get embedded flow configuration","isWebhook":false,"pointer":"/paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get embedded flow configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows uses this endpoint to load the configuration for a previously created link request. For an example flow, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows#hosted-recipient-creation-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"embeddedLinkRequestId","in":"path","schemaId":"schema_647","description":"The embedded link request ID.","required":true,"example":"ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198"}],"pointer":"/paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/embedded-flows/link-requests/{embeddedLinkRequestId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"embeddedLinkRequestId","in":"path","required":true,"example":"ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","429"],"pointer":"/embedded-flows/link-requests/{embeddedLinkRequestId}","href":"link-requests/embeddedlinkrequestget","openApiOperationId":"embeddedLinkRequestGet","summary":"Get embedded flow configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Embedded link request found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_708","exampleIds":["paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_708","exampleIds":["paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"User is not authorised to access the resource.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Embedded link request not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_708","exampleIds":["paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_708","exampleIds":["paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/link-requests/embeddedlinkrequestget"}],"panels":[]}]},"httpPath":"/embedded-flows/link-requests/{embeddedLinkRequestId}"}],"content":{"contentType":"group","meta":{"name":"link-requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link Requests","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows are Wise-hosted flows that partners can open for their users or embed inside their own product with an iframe or mobile WebView."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the embedded link request endpoints to create a short-lived flow URL for a profile or retrieve an embedded link request by ID. For an overview of when to use Embedded Flows, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/embedded-flows/link-requests/recipients","summary":"Recipient creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/link-requests/recipientembeddedlinkrequestcreate","deprecated":false},{"title":"/profiles/{profileId}/embedded-flows/link-requests/payment-instrument","summary":"Payment instrument creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/link-requests/paymentinstrumentembeddedlinkrequestcreate","deprecated":false},{"title":"/profiles/{profileId}/embedded-flows/link-requests/kyc-reviews","summary":"KYC review completion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/link-requests/kycreviewsembeddedlinkrequestcreate","deprecated":false},{"title":"/embedded-flows/link-requests/{embeddedLinkRequestId}","summary":"Get embedded flow configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/link-requests/embeddedlinkrequestget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Strong Customer Authentication","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"one-time-token"},"seo":{"title":"One-Time Token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"One-Time Token","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/one-time-token"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottStatusGet","name":"Get status of a one time token","isWebhook":false,"pointer":"/paths/~1one-time-token~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get status of a one time token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve necessary information to clear a OTT.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/one-time-token/status","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/one-time-token/status","href":"sca-ott/ottstatusget","openApiOperationId":"ottStatusGet","summary":"Get status of a one time token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One time token status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1status/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1status/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-ott/ottstatusget"}],"panels":[]}]},"httpPath":"/one-time-token/status"}],"content":{"contentType":"group","meta":{"name":"sca-ott"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"One Time Token","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-time tokens are temporary authentication sessions used to track SCA challenges. When an SCA-protected endpoint is called, a one-time token is returned containing the challenges that must be completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how SCA integration works."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"One-Time Token","link":"/sca-ott/one-time-token","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/one-time-token/status","summary":"Get status of a one time token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sca-ott/ottstatusget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaSessionCreate","name":"Create a SCA session","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1sca-sessions~1authorise/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a SCA session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Manually triggers SCA, returning a one-time token along with a list of associated challenges. These challenges can be cleared with the verify endpoints.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1sca-sessions~1authorise/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1sca-sessions~1authorise/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/sca-sessions/authorise","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/sca-sessions/authorise","href":"sca-sessions/scasessioncreate","openApiOperationId":"scaSessionCreate","summary":"Create a SCA session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of challenges to clear SCA.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}},"schemaId":"schema_709","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1sca-sessions~1authorise/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_709","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-sessions/scasessioncreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/sca-sessions/authorise"}],"content":{"contentType":"group","meta":{"name":"sca-sessions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SCA Sessions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA sessions allow you to manually trigger Strong Customer Authentication, returning a one-time token along with a list of associated challenges. These challenges can be cleared using the verify endpoints for PIN, device fingerprints, and facemaps."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how SCA integration works."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please reach out to your Implementation Manager to determine which challenges can be enabled."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/sca-sessions/authorise","summary":"Create a SCA session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-sessions/scasessioncreate","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaPinCreate","name":"Create a PIN","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1pin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new PIN factor used to resolve a SCA knowledge challenge type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request and response are encrypted using the JOSE framework. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how encryption and decryption work."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1pin/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_710","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"Content-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"X-tw-jose-method","in":"header","schemaId":"schema_712","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1pin/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1profiles~1{profileId}~1pin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/pin","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_710"},{"name":"Accept-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"Content-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"X-tw-jose-method","in":"header","required":true,"schemaId":"schema_712"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","409","429"],"pointer":"/profiles/{profileId}/pin","href":"sca-pin/scapincreate","openApiOperationId":"scaPinCreate","summary":"Create a PIN"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \\\n 'https://api.wise-sandbox.com/v2/profiles/{profileId}/pin' \\\n -H 'Authorization: Bearer ' \\\n -H 'Accept: application/jose+json' \\\n -H 'Accept-Encoding: identity' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'Content-Encoding: identity' \\\n -H 'X-tw-jose-method: jwe' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcx...'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The PIN has been successfully created.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"A PIN has already been created for this profile.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1pin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"409"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-pin/scapincreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/pin"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaPinDelete","name":"Delete a PIN","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1pin/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a PIN associated to a profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a PIN for a profile, use this endpoint followed by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-pin/scapincreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a PIN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is irreversible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1pin/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1pin/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/pin","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404","429"],"pointer":"/profiles/{profileId}/pin","href":"sca-pin/scapindelete","openApiOperationId":"scaPinDelete","summary":"Delete a PIN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The PIN has been deleted.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"No PIN has been set up for this profile.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1pin/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-pin/scapindelete"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/pin"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaPinVerify","name":"Verify a PIN","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1pin~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies a PIN challenge when calling a SCA-secured endpoint. Make sure to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-pin/scapincreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a PIN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before using this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request and response are encrypted using the JOSE framework. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how encryption and decryption work."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1pin~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_647","description":"A one-time token unique identifier.","required":true},{"name":"Accept","in":"header","schemaId":"schema_710","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"Content-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"X-tw-jose-method","in":"header","schemaId":"schema_712","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1pin~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/pin/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_647"},{"name":"Accept","in":"header","required":true,"schemaId":"schema_710"},{"name":"Accept-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"Content-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"X-tw-jose-method","in":"header","required":true,"schemaId":"schema_712"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","400","404","429"],"pointer":"/profiles/{profileId}/pin/verify","href":"sca-pin/scapinverify","openApiOperationId":"scaPinVerify","summary":"Verify a PIN"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \\\n 'https://api.wise-sandbox.com/v2/profiles/{profileId}/pin/verify' \\\n -H 'Authorization: Bearer ' \\\n -H 'Accept: application/jose+json' \\\n -H 'Accept-Encoding: identity' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'Content-Encoding: identity' \\\n -H 'X-tw-jose-method: jwe' \\\n -H 'One-Time-Token: ' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcx...'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_713","exampleIds":["paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The PIN has been successfully verified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}},"schemaId":"components/schemas/one-time-token","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"The PIN verification failed or PIN was blocked.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"The PIN was not found or has not been set up.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1pin~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/one-time-token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}}},{"code":"400"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-pin/scapinverify"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/pin/verify"}],"content":{"contentType":"group","meta":{"name":"sca-pin"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PIN","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN (Personal Identification Number) is a knowledge-based SCA challenge factor. Users create a 4-digit PIN that can be used to verify their identity when accessing SCA-protected endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All PIN creation and verification requests use JOSE (JWE) encryption to ensure the PIN is never transmitted in plain text. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for encryption details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/pin","summary":"Create a PIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-pin/scapincreate","deprecated":false},{"title":"/profiles/{profileId}/pin","summary":"Delete a PIN","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sca-pin/scapindelete","deprecated":false},{"title":"/profiles/{profileId}/pin/verify","summary":"Verify a PIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-pin/scapinverify","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaFacemapCreate","name":"Create a facemap","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1facemaps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a facemap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new facemap factor used to resolve a SCA inherence challenge type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A facemap should be exported from your FaceTec server using the SDK's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.facetec.com/api-guide#export-3d-facemap"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"export API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please use Wise's FaceTec "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/facetec/facetecpublickeyget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to encrypt the facemap during the export process."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/facemaps","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","409","429"],"pointer":"/profiles/{profileId}/facemaps","href":"sca-facemaps/scafacemapcreate","openApiOperationId":"scaFacemapCreate","summary":"Create a facemap"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The facemap has been successfully created.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"A facemap has already been created for this profile.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"409"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-facemaps/scafacemapcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/facemaps"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaFacemapDelete","name":"Delete a facemap","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1facemaps/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a facemap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a facemap associated to a profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a facemap for a profile, use this endpoint followed by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-facemaps/scafacemapcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a facemap"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is irreversible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/facemaps","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404","429"],"pointer":"/profiles/{profileId}/facemaps","href":"sca-facemaps/scafacemapdelete","openApiOperationId":"scaFacemapDelete","summary":"Delete a facemap"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The facemap has been deleted.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"No facemap has been set up for this profile.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-facemaps/scafacemapdelete"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/facemaps"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaFacemapVerify","name":"Verify a facemap","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1facemaps~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a facemap","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies a facemap challenge when calling a SCA-secured endpoint. Make sure to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-facemaps/scafacemapcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a facemap"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before using this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A facemap should be exported from your FaceTec server using the SDK's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://dev.facetec.com/api-guide#export-3d-facemap"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"export API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please use Wise's FaceTec "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/facetec/facetecpublickeyget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to encrypt a facemap during the export process."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_647","description":"A one-time token unique identifier.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/facemaps/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","429"],"pointer":"/profiles/{profileId}/facemaps/verify","href":"sca-facemaps/scafacemapverify","openApiOperationId":"scaFacemapVerify","summary":"Verify a facemap"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714","exampleIds":["paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The facemap has been successfully verified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}},"schemaId":"components/schemas/one-time-token","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"The facemap verification failed.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1facemaps~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/one-time-token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}}},{"code":"400"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-facemaps/scafacemapverify"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/facemaps/verify"}],"content":{"contentType":"group","meta":{"name":"sca-facemaps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Facemaps","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facemaps are inherence-based (biometric) SCA challenge factors that use FaceTec's 3D face recognition technology."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Facemaps should be exported from your FaceTec server using their SDK's export API. Use Wise's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/facetec/facetecpublickeyget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FaceTec public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to encrypt the facemap during export."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/facemaps","summary":"Create a facemap","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-facemaps/scafacemapcreate","deprecated":false},{"title":"/profiles/{profileId}/facemaps","summary":"Delete a facemap","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sca-facemaps/scafacemapdelete","deprecated":false},{"title":"/profiles/{profileId}/facemaps/verify","summary":"Verify a facemap","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-facemaps/scafacemapverify","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaDeviceFingerprintCreate","name":"Create a device fingerprint","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a device fingerprint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new device fingerprint factor used to resolve a SCA possession challenge type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request and response are encrypted using the JOSE framework. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how encryption and decryption work."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_710","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"Content-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"X-tw-jose-method","in":"header","schemaId":"schema_712","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_715","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_715","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/device-fingerprints","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_710"},{"name":"Accept-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"Content-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"X-tw-jose-method","in":"header","required":true,"schemaId":"schema_712"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_715","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","400","409","429"],"pointer":"/profiles/{profileId}/device-fingerprints","href":"sca-device-fingerprints/scadevicefingerprintcreate","openApiOperationId":"scaDeviceFingerprintCreate","summary":"Create a device fingerprint"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \\\n 'https://api.wise-sandbox.com/v2/profiles/{profileId}/device-fingerprints' \\\n -H 'Authorization: Bearer ' \\\n -H 'Accept: application/jose+json' \\\n -H 'Accept-Encoding: identity' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'Content-Encoding: identity' \\\n -H 'X-tw-jose-method: jwe' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcx...'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_715","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_715","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The device fingerprint has been successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_716","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Maximum number of device fingerprints reached (default is 3).","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"The device fingerprint has already been created.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_716","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"409"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-device-fingerprints/scadevicefingerprintcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/device-fingerprints"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaDeviceFingerprintVerify","name":"Verify a device fingerprint","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a device fingerprint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies a device fingerprint challenge when calling a SCA-secured endpoint. Make sure to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-device-fingerprints/scadevicefingerprintcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a device fingerprint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before using this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request and response are encrypted using the JOSE framework. Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how encryption and decryption work."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_647","description":"A one-time token unique identifier.","required":true},{"name":"Accept","in":"header","schemaId":"schema_710","required":true},{"name":"Accept-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"Content-Encoding","in":"header","schemaId":"schema_711","required":true},{"name":"X-tw-jose-method","in":"header","schemaId":"schema_712","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_717","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"]}},"schemaId":"schema_717","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/device-fingerprints/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_647"},{"name":"Accept","in":"header","required":true,"schemaId":"schema_710"},{"name":"Accept-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"Content-Encoding","in":"header","required":true,"schemaId":"schema_711"},{"name":"X-tw-jose-method","in":"header","required":true,"schemaId":"schema_712"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/jose+json":{"schemaId":"schema_717","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"]}},"responseCodes":["200","400","404","429"],"pointer":"/profiles/{profileId}/device-fingerprints/verify","href":"sca-device-fingerprints/scadevicefingerprintverify","openApiOperationId":"scaDeviceFingerprintVerify","summary":"Verify a device fingerprint"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \\\n 'https://api.wise-sandbox.com/v2/profiles/{profileId}/device-fingerprints/verify' \\\n -H 'Authorization: Bearer ' \\\n -H 'Accept: application/jose+json' \\\n -H 'Accept-Encoding: identity' \\\n -H 'Content-Type: application/jose+json' \\\n -H 'Content-Encoding: identity' \\\n -H 'X-tw-jose-method: jwe' \\\n -H 'One-Time-Token: ' \\\n -d 'eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcx...'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_717","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"],"mediaTypes":["application/jose+json"],"mediaTypeSchemas":{"application/jose+json":{"schemaId":"schema_717","exampleIds":["paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The device fingerprint has been successfully verified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}},"schemaId":"components/schemas/one-time-token","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"The device fingerprint verification failed.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"The device fingerprint was not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/one-time-token","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/one-time-token"}}},{"code":"400"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-device-fingerprints/scadevicefingerprintverify"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/device-fingerprints/verify"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"scaDeviceFingerprintDelete","name":"Delete a device fingerprint","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1{deviceFingerprintId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a device fingerprint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a device fingerprint associated to a profile. Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deviceFingerprintId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the URL to delete a device fingerprint. This ID is provided in the response when the device fingerprint is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is irreversible."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"deviceFingerprintId","in":"path","schemaId":"schema_647","description":"The device fingerprint ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1{deviceFingerprintId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1{deviceFingerprintId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"deviceFingerprintId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404","429"],"pointer":"/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}","href":"sca-device-fingerprints/scadevicefingerprintdelete","openApiOperationId":"scaDeviceFingerprintDelete","summary":"Delete a device fingerprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The device fingerprint has been deleted.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"The device fingerprint ID does not exist.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1device-fingerprints~1{deviceFingerprintId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-device-fingerprints/scadevicefingerprintdelete"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}"}],"content":{"contentType":"group","meta":{"name":"sca-device-fingerprints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Fingerprints","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device fingerprints are possession-based SCA challenge factors. They allow you to verify that a user is accessing the API from a recognized device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A profile can have up to 3 device fingerprints registered simultaneously. All device fingerprint operations use JOSE (JWE) encryption. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for encryption details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/device-fingerprints","summary":"Create a device fingerprint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-device-fingerprints/scadevicefingerprintcreate","deprecated":false},{"title":"/profiles/{profileId}/device-fingerprints/verify","summary":"Verify a device fingerprint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-device-fingerprints/scadevicefingerprintverify","deprecated":false},{"title":"/profiles/{profileId}/device-fingerprints/{deviceFingerprintId}","summary":"Delete a device fingerprint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sca-device-fingerprints/scadevicefingerprintdelete","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userSecurityPhoneNumberCreate","name":"Create Phone Number","isWebhook":false,"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Phone Number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a verified phone number for a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_650","description":"User ID.","required":true}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"schemaId":"schema_718","pointer":"/paths/~1application~1users~1{userId}~1phone-numbers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/application/users/{userId}/phone-numbers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_718"}},"responseCodes":["200","422","429"],"pointer":"/application/users/{userId}/phone-numbers","href":"sca-otp/usersecurityphonenumbercreate","openApiOperationId":"userSecurityPhoneNumberCreate","summary":"Create Phone Number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_718","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/phone-number"}},"schemaId":"components/schemas/phone-number","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"The phone number is already associated with another account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719","exampleIds":["paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_719","exampleIds":["paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/phone-number","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/phone-number"}}},{"code":"422","schemaId":"schema_719","exampleIds":["paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719","exampleIds":["paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/usersecurityphonenumbercreate"}],"panels":[]}]},"httpPath":"/application/users/{userId}/phone-numbers"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottSmsTrigger","name":"Trigger SMS Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1sms~1trigger/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger SMS Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To trigger a SMS challenge by sending SMS to user verified phone number. Contains a 6 digit one time password ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code to clear an SMS challenge by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottsmsverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify SMS endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1sms~1trigger/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/sms/trigger","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/one-time-token/sms/trigger","href":"sca-otp/ottsmstrigger","openApiOperationId":"ottSmsTrigger","summary":"Trigger SMS Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Trigger result with obfuscated phone number.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1sms~1trigger/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottsmstrigger"}],"panels":[]}]},"httpPath":"/one-time-token/sms/trigger"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottSmsVerify","name":"Verify SMS Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1sms~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify SMS Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clear a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" challenge listed in a OTT."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User is required to have a verified phone number. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/usersecurityphonenumbercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create phone number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottsmstrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger SMS Challenge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to be called first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since we won't be sending real SMS on sandbox, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"111111"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1sms~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"schemaId":"schema_721","pointer":"/paths/~1one-time-token~1sms~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/sms/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_721"}},"responseCodes":["200","429"],"pointer":"/one-time-token/sms/verify","href":"sca-otp/ottsmsverify","openApiOperationId":"ottSmsVerify","summary":"Verify SMS Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_721","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One time token status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1sms~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottsmsverify"}],"panels":[]}]},"httpPath":"/one-time-token/sms/verify"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottWhatsappTrigger","name":"Trigger WhatsApp Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1whatsapp~1trigger/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger WhatsApp Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To trigger a WhatsApp challenge by sending WhatsApp message to user verified phone number. Contains a 6 digit one time password ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code to clear a WHATSAPP challenge by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottwhatsappverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify WhatsApp endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1whatsapp~1trigger/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/whatsapp/trigger","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/one-time-token/whatsapp/trigger","href":"sca-otp/ottwhatsapptrigger","openApiOperationId":"ottWhatsappTrigger","summary":"Trigger WhatsApp Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Trigger result with obfuscated phone number.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}},"schemaId":"schema_722","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1whatsapp~1trigger/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottwhatsapptrigger"}],"panels":[]}]},"httpPath":"/one-time-token/whatsapp/trigger"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottWhatsappVerify","name":"Verify WhatsApp Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1whatsapp~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify WhatsApp Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clear a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WHATSAPP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" challenge listed in a OTT."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User is required to have a verified phone number. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/usersecurityphonenumbercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create phone number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottwhatsapptrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger WhatsApp Challenge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to be called first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since we won't be sending real WhatsApp message on sandbox, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"111111"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1whatsapp~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"schemaId":"schema_721","pointer":"/paths/~1one-time-token~1whatsapp~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/whatsapp/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_721"}},"responseCodes":["200","429"],"pointer":"/one-time-token/whatsapp/verify","href":"sca-otp/ottwhatsappverify","openApiOperationId":"ottWhatsappVerify","summary":"Verify WhatsApp Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_721","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One time token status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1whatsapp~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottwhatsappverify"}],"panels":[]}]},"httpPath":"/one-time-token/whatsapp/verify"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottVoiceTrigger","name":"Trigger Voice Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1voice~1trigger/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger Voice Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To trigger a Voice challenge by sending voice message to user verified phone number. Contains a 6 digit one time password ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code to clear a VOICE challenge by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottvoiceverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify Voice endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1voice~1trigger/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/voice/trigger","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/one-time-token/voice/trigger","href":"sca-otp/ottvoicetrigger","openApiOperationId":"ottVoiceTrigger","summary":"Trigger Voice Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Trigger result with obfuscated phone number.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}},"schemaId":"schema_723","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1voice~1trigger/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottvoicetrigger"}],"panels":[]}]},"httpPath":"/one-time-token/voice/trigger"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ottVoiceVerify","name":"Verify Voice Challenge","isWebhook":false,"pointer":"/paths/~1one-time-token~1voice~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Voice Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clear a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VOICE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" challenge listed in a OTT."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User is required to have a verified phone number. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/usersecurityphonenumbercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create phone number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottvoicetrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger Voice Challenge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required to be called first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since we won't be sending real voice message on sandbox, the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTP Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"111111"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"One-Time-Token","in":"header","schemaId":"schema_639","description":"Text value of a OTT.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1one-time-token~1voice~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"schemaId":"schema_721","pointer":"/paths/~1one-time-token~1voice~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/one-time-token/voice/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"One-Time-Token","in":"header","required":true,"schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_721"}},"responseCodes":["200","429"],"pointer":"/one-time-token/voice/verify","href":"sca-otp/ottvoiceverify","openApiOperationId":"ottVoiceVerify","summary":"Verify Voice Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_721","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One time token status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1one-time-token~1voice~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ott-response","exampleIds":["paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/ottvoiceverify"}],"panels":[]}]},"httpPath":"/one-time-token/voice/verify"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userSecurityPhoneNumberDelete","name":"Delete Phone Number","isWebhook":false,"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers~1{phoneNumberId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Phone Number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a verified phone number for a user."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is restricted and requires both a client credentials token and additional access to use. Please speak with your implementation manager if you would like to use this API."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_650","description":"User ID.","required":true},{"name":"phoneNumberId","in":"path","schemaId":"schema_650","description":"ID of a phone number.","required":true}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers~1{phoneNumberId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers~1{phoneNumberId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/application/users/{userId}/phone-numbers/{phoneNumberId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_650"},{"name":"phoneNumberId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","429"],"pointer":"/application/users/{userId}/phone-numbers/{phoneNumberId}","href":"sca-otp/usersecurityphonenumberdelete","openApiOperationId":"userSecurityPhoneNumberDelete","summary":"Delete Phone Number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1application~1users~1{userId}~1phone-numbers~1{phoneNumberId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sca-otp/usersecurityphonenumberdelete"}],"panels":[]}]},"httpPath":"/application/users/{userId}/phone-numbers/{phoneNumberId}"}],"content":{"contentType":"group","meta":{"name":"sca-otp"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OTP","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For phone-based OTP (one-time password) authentication — where an OTP is a single-use 6-digit code sent to verify the identity of a user — Wise supports multiple delivery methods, including SMS, WhatsApp, and voice. Use Wise's secure endpoint to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/usersecurityphonenumbercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and register the end user's phone number. Then, call the trigger endpoints ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottsmstrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottwhatsapptrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottvoicetrigger"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to send an OTP to the registered number. Finally, submit the OTP via the verify endpoints ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottsmsverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottwhatsappverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-otp/ottvoiceverify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to complete the authentication challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-over-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCA over API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how SCA integration works."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/application/users/{userId}/phone-numbers","summary":"Create Phone Number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/usersecurityphonenumbercreate","deprecated":false},{"title":"/one-time-token/sms/trigger","summary":"Trigger SMS Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottsmstrigger","deprecated":false},{"title":"/one-time-token/sms/verify","summary":"Verify SMS Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottsmsverify","deprecated":false},{"title":"/one-time-token/whatsapp/trigger","summary":"Trigger WhatsApp Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottwhatsapptrigger","deprecated":false},{"title":"/one-time-token/whatsapp/verify","summary":"Verify WhatsApp Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottwhatsappverify","deprecated":false},{"title":"/one-time-token/voice/trigger","summary":"Trigger Voice Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottvoicetrigger","deprecated":false},{"title":"/one-time-token/voice/verify","summary":"Verify Voice Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sca-otp/ottvoiceverify","deprecated":false},{"title":"/application/users/{userId}/phone-numbers/{phoneNumberId}","summary":"Delete Phone Number","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sca-otp/usersecurityphonenumberdelete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Balances","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Balance"},"seo":{"title":"Balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Balance"},"children":[]}]}]}},{"type":"link","label":"HoldLimitBreach","link":"/api-reference/balance/holdlimitbreach","routeSlug":"/api-reference/balance/holdlimitbreach","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"HoldLimitBreach"},"seo":{"title":"HoldLimitBreach"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HoldLimitBreach","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/HoldLimitBreach"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceCreate","name":"Create a Balance Account","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Balance Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a balance within the specified profile, in the currency and type specified in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balances, only one can be created per currency. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balances, multiple in the same currency can be opened."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type balance, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-idempotence-uuid","in":"header","schemaId":"schema_647","description":"Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making a retry call.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_724","exampleIds":["paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1balances/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/balances","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-idempotence-uuid","in":"header","required":true,"schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","429"],"pointer":"/profiles/{profileId}/balances","href":"balance/balancecreate","openApiOperationId":"balanceCreate","summary":"Create a Balance Account","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_724","exampleIds":["paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_724","exampleIds":["paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - Balance successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balance"}},"schemaId":"components/schemas/Balance","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Balance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balance"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancecreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceList","name":"List Balances for a Profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Balances for a Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must include at least one type. To return more than one type, comma-separate the values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"types","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of balance types to return. Acceptable values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STANDARD"}],"pointer":"/paths/~1profiles~1{profileId}~1balances/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/balances","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"types","in":"query","required":true,"example":"STANDARD","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/balances","href":"balance/balancelist","openApiOperationId":"balanceList","summary":"List Balances for a Profile","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved balances.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_725"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancelist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceGet","name":"Retrieve a Balance by ID","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Balance by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a balance based on the specified balance ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"balanceId","in":"path","schemaId":"schema_650","description":"The balance ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/balances/{balanceId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"balanceId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/balances/{balanceId}","href":"balance/balanceget","openApiOperationId":"balanceGet","summary":"Retrieve a Balance by ID","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved the balance.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balance"}},"schemaId":"components/schemas/Balance","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Balance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balance"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balanceget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances/{balanceId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceDelete","name":"Remove a Balance Account","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a Balance Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Closes a balance account for the user's profile.\n\nBalance accounts must have a zero balance to be closed. Bank account details for the balance will also be deactivated and may not be restored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"balanceId","in":"path","schemaId":"schema_650","description":"The balance ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/balances/{balanceId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"balanceId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","429"],"pointer":"/profiles/{profileId}/balances/{balanceId}","href":"balance/balancedelete","openApiOperationId":"balanceDelete","summary":"Remove a Balance Account","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - Balance successfully removed.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1{balanceId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancedelete"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances/{balanceId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceMovement","name":"Convert or Move Money Between Balances","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balance-movements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Convert or Move Money Between Balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows conversion and movement of funds between balance accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convert across balance accounts:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convert funds between two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balance accounts in different currencies. Requires a quote created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"payOut\": \"BALANCE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Move money between balances:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add money to a same-currency jar (move from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without conversion)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add money to another-currency jar (convert money using a quote)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdraw money from a jar (move from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without conversion)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cross-currency movements."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balance-movements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-idempotence-uuid","in":"header","schemaId":"schema_647","description":"Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making a retry call.","required":true},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-movements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion","paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"]}},"schemaId":"schema_726","exampleIds":["paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion","paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"],"pointer":"/paths/~1profiles~1{profileId}~1balance-movements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/balance-movements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-idempotence-uuid","in":"header","required":true,"schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion","paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"]}},"responseCodes":["201","429"],"pointer":"/profiles/{profileId}/balance-movements","href":"balance/balancemovement","openApiOperationId":"balanceMovement","summary":"Convert or Move Money Between Balances","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_726","exampleIds":["paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion","paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_726","exampleIds":["paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion","paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - Movement completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-movements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_727"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancemovement"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balance-movements"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceCapacity","name":"Retrieve Deposit Limits","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balance-capacity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Deposit Limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the deposit limit for a profile based on regulatory requirements.\n\nUseful for personal profiles located in countries that have hold limits. We advise calling this API before depositing money into an account if the profile is located in Singapore or Malaysia.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balance-capacity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_639","description":"Currency code (ISO 4217 Alphabetic Code). The deposit limit will be returned in this currency.","required":true,"example":"SGD"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-capacity/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-capacity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/balance-capacity","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"currency","in":"query","required":true,"example":"SGD","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/balance-capacity","href":"balance/balancecapacity","openApiOperationId":"balanceCapacity","summary":"Retrieve Deposit Limits","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved deposit limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}},"schemaId":"schema_728","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-capacity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/balancecapacity"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balance-capacity"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"excessMoneyAccount","name":"Add an Excess Money Account","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1excess-money-account/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an Excess Money Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day.\n\nUse this endpoint to specify a recipient where excess money will be transferred.\n\nPrimarily used for Singapore and Malaysia customers.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1excess-money-account/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1excess-money-account/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_729"}},"schemaId":"schema_729","pointer":"/paths/~1profiles~1{profileId}~1excess-money-account/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/excess-money-account","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_729"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/excess-money-account","href":"balance/excessmoneyaccount","openApiOperationId":"excessMoneyAccount","summary":"Add an Excess Money Account","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_729","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_729"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Excess money account configured successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_730"}},"schemaId":"schema_730","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1excess-money-account/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_730","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_730"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/excessmoneyaccount"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/excess-money-account"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"totalFunds","name":"Get Total Funds","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1total-funds~1{currency}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Total Funds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides an overview of your account's total valuation and available liquidity across all balances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns total worth, total available (including overdraft), total cash, and overdraft details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"balance/totalfunds/request/example-(assuming-gbp-and-usd-has-1:1-exchange-rate)","deepLinkHash":"/balance/totalfunds#balance/totalfunds/request/example-(assuming-gbp-and-usd-has-1:1-exchange-rate)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example (Assuming GBP and USD has 1:1 exchange rate)"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Worth"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total Available"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdraft Usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overdraft Limit"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive account value with no overdraft"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Positive account value with overdraft"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2000"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1900"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative account value with overdraft"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"currency","in":"path","schemaId":"schema_639","description":"Currency code (ISO 4217 Alphabetic Code). All values will be converted to this currency.","required":true,"example":"EUR"}],"pointer":"/paths/~1profiles~1{profileId}~1total-funds~1{currency}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1total-funds~1{currency}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/total-funds/{currency}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"currency","in":"path","required":true,"example":"EUR","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/total-funds/{currency}","href":"balance/totalfunds","openApiOperationId":"totalFunds","summary":"Get Total Funds","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved total funds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1total-funds~1{currency}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/totalfunds"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/total-funds/{currency}"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"holdLimitBreachList","name":"List hold limit breaches","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List hold limit breaches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can optionally filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closing_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_732","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by breach state. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]}]}]}],"example":"OPEN"},{"name":"closingReason","in":"query","schemaId":"schema_732","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by closing reason. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTOMATICALLY_RESOLVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANUALLY_RESOLVED"},"children":[]}]}]}],"example":"AUTOMATICALLY_RESOLVED"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/balances/hold-limit-breach","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"state","in":"query","required":false,"example":"OPEN","schemaId":"schema_732"},{"name":"closingReason","in":"query","required":false,"example":"AUTOMATICALLY_RESOLVED","schemaId":"schema_732"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","403","429"],"pointer":"/profiles/{profileId}/balances/hold-limit-breach","href":"balance/holdlimitbreachlist","openApiOperationId":"holdLimitBreachList","summary":"List hold limit breaches","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of hold limit breaches.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_733"}},"schemaId":"schema_733","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid closing reason or state used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_734"}},"schemaId":"schema_734","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Caller does not have access to the profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}},"schemaId":"schema_735","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_733","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_733"}}},{"code":"400","schemaId":"schema_734","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_734"}}},{"code":"403","schemaId":"schema_735","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/holdlimitbreachlist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances/hold-limit-breach"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"holdLimitBreachClose","name":"Close a hold limit breach","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach~1{holdLimitBreachId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close a hold limit breach","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only breaches with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be closed via this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"holdLimitBreachId","in":"path","schemaId":"schema_650","description":"The hold limit breach ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach~1{holdLimitBreachId}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach~1{holdLimitBreachId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_736"}},"schemaId":"schema_736","pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach~1{holdLimitBreachId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"holdLimitBreachId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_736"}},"responseCodes":["204","400","403","404","429"],"pointer":"/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}","href":"balance/holdlimitbreachclose","openApiOperationId":"holdLimitBreachClose","summary":"Close a hold limit breach","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_736","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_736"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Returns 204 No Content on success.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid state used.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_737"}},"schemaId":"schema_737","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Caller attempts to close a holdLimitBreach that does not belong to them.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}},"schemaId":"schema_738","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Caller attempts to close a holdLimitBreach that does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_739"}},"schemaId":"schema_739","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balances~1hold-limit-breach~1{holdLimitBreachId}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_737","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_737"}}},{"code":"403","schemaId":"schema_738","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}}},{"code":"404","schemaId":"schema_739","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_739"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/holdlimitbreachclose"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventHoldLimitBreachUpdate","name":"Hold limit breach update","isWebhook":true,"pointer":"/paths/hold-limit-breach#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hold limit breach update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine whether the breach has been opened or closed, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.closing_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how it was resolved."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hold-limit-breach#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/hold-limit-breach#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"],"pointer":"/paths/hold-limit-breach#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"hold-limit-breach#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"responseCodes":["200"],"pointer":"hold-limit-breach#update","href":"balance/eventholdlimitbreachupdate","openApiOperationId":"eventHoldLimitBreachUpdate","summary":"Hold limit breach update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/hold-limit-breach#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/eventholdlimitbreachupdate"}],"panels":[]}]},"httpPath":"hold-limit-breach#update"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBalancesUpdate","name":"Balance update","isWebhook":true,"pointer":"/paths/balances#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a multi-currency account is credited or debited."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.step_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to order events within a single transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tracking events related to a single transaction such as a cancelled card transaction, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.step_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/balances#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_740"}},"schemaId":"schema_740","pointer":"/paths/balances#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"balances#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_740"}},"responseCodes":["200"],"pointer":"balances#update","href":"balance/eventbalancesupdate","openApiOperationId":"eventBalancesUpdate","summary":"Balance update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_740","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_740"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/balances#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/eventbalancesupdate"}],"panels":[]}]},"httpPath":"balances#update"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBalancesAccountStateChange","name":"Balance account state change","isWebhook":true,"pointer":"/paths/balances#account-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance account state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a balance account is activated or deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#account-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/balances#account-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_741"}},"schemaId":"schema_741","pointer":"/paths/balances#account-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"balances#account-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_741"}},"responseCodes":["200"],"pointer":"balances#account-state-change","href":"balance/eventbalancesaccountstatechange","openApiOperationId":"eventBalancesAccountStateChange","summary":"Balance account state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_741","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_741"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/balances#account-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance/eventbalancesaccountstatechange"}],"panels":[]}]},"httpPath":"balances#account-state-change"}],"content":{"contentType":"group","meta":{"name":"balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and manage balance accounts within a multi-currency account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each profile can hold multiple balance accounts in different currencies. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balance is limited to one per currency, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balances (Jars) allow multiple in the same currency. Creating the first balance for a profile automatically creates the multi-currency account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balances include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"investmentState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Only balances with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_INVESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be operated on via the API. Invested balances should be shown but not actionable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a complete guide on multi-currency accounts, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Currency Accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Balance","link":"/balance/balance","deprecated":false},{"title":"HoldLimitBreach","link":"/balance/holdlimitbreach","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/balances","summary":"Create a Balance Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/balancecreate","deprecated":false},{"title":"/profiles/{profileId}/balances","summary":"List Balances for a Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/balancelist","deprecated":false},{"title":"/profiles/{profileId}/balances/{balanceId}","summary":"Retrieve a Balance by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/balanceget","deprecated":false},{"title":"/profiles/{profileId}/balances/{balanceId}","summary":"Remove a Balance Account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/balance/balancedelete","deprecated":false},{"title":"/profiles/{profileId}/balance-movements","summary":"Convert or Move Money Between Balances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/balancemovement","deprecated":false},{"title":"/profiles/{profileId}/balance-capacity","summary":"Retrieve Deposit Limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/balancecapacity","deprecated":false},{"title":"/profiles/{profileId}/excess-money-account","summary":"Add an Excess Money Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/excessmoneyaccount","deprecated":false},{"title":"/profiles/{profileId}/total-funds/{currency}","summary":"Get Total Funds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/totalfunds","deprecated":false},{"title":"/profiles/{profileId}/balances/hold-limit-breach","summary":"List hold limit breaches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance/holdlimitbreachlist","deprecated":false},{"title":"/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}","summary":"Close a hold limit breach","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/holdlimitbreachclose","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"hold-limit-breach#update","summary":"Hold limit breach update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/eventholdlimitbreachupdate","deprecated":false},{"title":"balances#update","summary":"Balance update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/eventbalancesupdate","deprecated":false},{"title":"balances#account-state-change","summary":"Balance account state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance/eventbalancesaccountstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balanceStatementGet","name":"Get Balance Statement","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1balance-statements~1{balanceId}~1statement.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Balance Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a statement for the specified balance account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response format depends on the URL path:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - JSON format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CSV format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PDF format (includes Wise branding)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.xlsx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Excel format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.xml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CAMT.053 XML format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.mt940"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - MT940 format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement.qif"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - QIF format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intervalStart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intervalEnd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot exceed 469 days (around 1 year 3 months)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The additional authentication is only required once every 90 days, viewing the statement on the website or in the mobile app counts towards that as well."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true,"example":12345},{"name":"balanceId","in":"path","schemaId":"schema_650","description":"The balance ID to get the statement for.","required":true,"example":64}],"pointer":"/paths/~1profiles~1{profileId}~1balance-statements~1{balanceId}~1statement.json/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_639","description":"Currency of the balance statement requested (ISO 4217 Alphabetic Code).","required":true,"example":"EUR"},{"name":"intervalStart","in":"query","schemaId":"schema_742","description":"Statement start time in UTC.","required":true,"example":"2025-03-01T00:00:00.000Z"},{"name":"intervalEnd","in":"query","schemaId":"schema_742","description":"Statement end time in UTC.","required":true,"example":"2025-04-30T23:59:59.999Z"},{"name":"type","in":"query","schemaId":"schema_743","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPACT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Single statement line per transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FLAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Accounting statements where transaction fees are on a separate line"},"children":[]}]}]}]}],"example":"COMPACT"},{"name":"statementLocale","in":"query","schemaId":"schema_639","description":"Language for the statement. Supports 2 character language codes.","example":"en"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-statements~1{balanceId}~1statement.json/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-statements~1{balanceId}~1statement.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/balance-statements/{balanceId}/statement.json","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_650"},{"name":"balanceId","in":"path","required":true,"example":64,"schemaId":"schema_650"}],"query":[{"name":"currency","in":"query","required":true,"example":"EUR","schemaId":"schema_639"},{"name":"intervalStart","in":"query","required":true,"example":"2025-03-01T00:00:00.000Z","schemaId":"schema_742"},{"name":"intervalEnd","in":"query","required":true,"example":"2025-04-30T23:59:59.999Z","schemaId":"schema_742"},{"name":"type","in":"query","required":false,"example":"COMPACT","schemaId":"schema_743"},{"name":"statementLocale","in":"query","required":false,"example":"en","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/balance-statements/{balanceId}/statement.json","href":"balance-statement/balancestatementget","openApiOperationId":"balanceStatementGet","summary":"Get Balance Statement","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved balance statement.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_744"}},"schemaId":"schema_744","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1balance-statements~1{balanceId}~1statement.json/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_744","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_744"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-statement/balancestatementget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/balance-statements/{balanceId}/statement.json"}],"content":{"contentType":"group","meta":{"name":"balance-statement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance Statements","showPageActions":true},{"nodeType":"markdoc","content":"Balance statements contain transactional activities on a Wise Multi-Currency Account, including deposits, withdrawals, conversions, card transactions, and fees.\n\nStatements can be retrieved in multiple formats: JSON, CSV, PDF, XLSX, CAMT.053, MT940, or QIF."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/balance-statements/{balanceId}/statement.json","summary":"Get Balance Statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance-statement/balancestatementget","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BankAccountDetails"},"seo":{"title":"Bank Account Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Account Details","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BankAccountDetails"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankAccountDetailsBankDetailsCreate","name":"Create multiple bank account details","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1bank-details/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create multiple bank account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please reach out to our Support Team for access to this endpoint."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile to create bank account details for.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1bank-details/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1bank-details/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_746"}},"schemaId":"schema_746","pointer":"/paths/~1profiles~1{profileId}~1bank-details/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/bank-details","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_746"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/bank-details","href":"bank-account-details/bankaccountdetailsbankdetailscreate","openApiOperationId":"bankAccountDetailsBankDetailsCreate","summary":"Create multiple bank account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_746","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_746"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bank account details created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_747"}},"schemaId":"schema_747","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1bank-details/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_747","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_747"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/bankaccountdetailsbankdetailscreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/bank-details"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankAccountDetailsGet","name":"Retrieve bank account details","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1account-details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve bank account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list with all the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example bank account details are returned for any currency where bank account details have not been requested and issued. Examples will always include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile to retrieve bank account details for.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1account-details/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/account-details","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/account-details","href":"bank-account-details/bankaccountdetailsget","openApiOperationId":"bankAccountDetailsGet","summary":"Retrieve bank account details","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of bank account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_748"}},"schemaId":"schema_748","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_748","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_748"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/bankaccountdetailsget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/account-details"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankAccountDetailsOrderCreate","name":"Create bank account details order","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bank account details order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible values for a requirement status are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The requirement has some pending action from the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_TW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The requirement has some pending action from Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The requirement is completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The more common requirements are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user needs to be fully verified before completing this requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOP_UP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A fee will be charged and must be paid through wise.com before completing this requirement."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile to create the bank account details order for.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_749"}},"schemaId":"schema_749","pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/account-details-orders","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_749"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/account-details-orders","href":"bank-account-details/bankaccountdetailsordercreate","openApiOperationId":"bankAccountDetailsOrderCreate","summary":"Create bank account details order","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_749","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_749"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bank account details order created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_750"}},"schemaId":"schema_750","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_750","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_750"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/bankaccountdetailsordercreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/account-details-orders"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankAccountDetailsOrdersList","name":"List bank account detail orders","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bank account detail orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the bank account assignment requests for a profile and multi-currency account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes bank-details orders in the following statuses: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_TW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile to list bank account detail orders for.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_751","description":"Currency code (ISO 4217 Alphabetic Code).","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/account-details-orders","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"}],"query":[{"name":"currency","in":"query","required":true,"example":"GBP","schemaId":"schema_751"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/account-details-orders","href":"bank-account-details/bankaccountdetailsorderslist","openApiOperationId":"bankAccountDetailsOrdersList","summary":"List bank account detail orders","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of bank account detail orders.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}},"schemaId":"schema_752","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details-orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_752","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_752"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/bankaccountdetailsorderslist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/account-details-orders"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankAccountDetailsReturnsCreate","name":"Create payment return","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1account-details~1payments~1{paymentId}~1returns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment return","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a return for a payment received to bank account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you create a return, you must provide the ID of the payment you wish to return as well as the ID of the profile that received the payment. In addition, you can provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the return in the request body. When returning SWIFT payments, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a required field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that received the payment.","required":true},{"name":"paymentId","in":"path","schemaId":"schema_753","description":"The ID of the payment to return.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1account-details~1payments~1{paymentId}~1returns/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details~1payments~1{paymentId}~1returns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_754"}},"schemaId":"schema_754","pointer":"/paths/~1profiles~1{profileId}~1account-details~1payments~1{paymentId}~1returns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/account-details/payments/{paymentId}/returns","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"paymentId","in":"path","required":true,"example":987654321,"schemaId":"schema_753"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_754"}},"responseCodes":["201","400","404","429"],"pointer":"/profiles/{profileId}/account-details/payments/{paymentId}/returns","href":"bank-account-details/bankaccountdetailsreturnscreate","openApiOperationId":"bankAccountDetailsReturnsCreate","summary":"Create payment return"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_754","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_754"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment return created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}},"schemaId":"schema_755","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_756"}},"schemaId":"schema_756","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_757"}},"schemaId":"schema_757","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1account-details~1payments~1{paymentId}~1returns/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_755","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}}},{"code":"400","schemaId":"schema_756","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_756"}}},{"code":"404","schemaId":"schema_757","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_757"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/bankaccountdetailsreturnscreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/account-details/payments/{paymentId}/returns"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventAccountDetailsOrderStateChange","name":"Account details order state change","isWebhook":true,"pointer":"/paths/account-details-order#order-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account details order state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account-details-order#order-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values for an order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One or more requirements has some pending action from the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_TW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One or more requirements has some pending action from Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All requirements are completed and pending account details to be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All requirements are completed and account details has also been created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/account-details-order-state-flow.208d24156d3d1cfd3d0e3ce910f5c0b9f016f9152a3cbcbc648a67e5fc545c7f.28b10c14.png","alt":"Create account details order statuses transition diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most common requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user needs to be fully verified before completing this requirement."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.modification_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/account-details-order#order-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758","pointer":"/paths/account-details-order#order-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"account-details-order#order-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_758"}},"responseCodes":["200"],"pointer":"account-details-order#order-state-change","href":"bank-account-details/eventaccountdetailsorderstatechange","openApiOperationId":"eventAccountDetailsOrderStateChange","summary":"Account details order state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_758"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/account-details-order#order-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/eventaccountdetailsorderstatechange"}],"panels":[]}]},"httpPath":"account-details-order#order-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventAccountDetailsPaymentStateChange","name":"Account details payment state change","isWebhook":true,"pointer":"/paths/account-details-payment#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account details payment state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a pay-in is made into the specified account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account-details-payment#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/account-details-payment#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_759"}},"schemaId":"schema_759","pointer":"/paths/account-details-payment#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"account-details-payment#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_759"}},"responseCodes":["200"],"pointer":"account-details-payment#state-change","href":"bank-account-details/eventaccountdetailspaymentstatechange","openApiOperationId":"eventAccountDetailsPaymentStateChange","summary":"Account details payment state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_759","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_759"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/account-details-payment#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-account-details/eventaccountdetailspaymentstatechange"}],"panels":[]}]},"httpPath":"account-details-payment#state-change"}],"content":{"contentType":"group","meta":{"name":"bank-account-details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Account Details","showPageActions":true},{"nodeType":"markdoc","content":"Bank account details allow users to receive money into their Wise Multi-Currency Account. Each currency balance can have local bank details (for domestic payments) and international bank details (for SWIFT payments) where available.\n\nBank account details can be retrieved for existing balances, or new details can be ordered for currencies where they're available but not yet issued."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Bank Account Details","link":"/bank-account-details/bankaccountdetails","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/bank-details","summary":"Create multiple bank account details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-account-details/bankaccountdetailsbankdetailscreate","deprecated":false},{"title":"/profiles/{profileId}/account-details","summary":"Retrieve bank account details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bank-account-details/bankaccountdetailsget","deprecated":false},{"title":"/profiles/{profileId}/account-details-orders","summary":"Create bank account details order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-account-details/bankaccountdetailsordercreate","deprecated":false},{"title":"/profiles/{profileId}/account-details-orders","summary":"List bank account detail orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bank-account-details/bankaccountdetailsorderslist","deprecated":false},{"title":"/profiles/{profileId}/account-details/payments/{paymentId}/returns","summary":"Create payment return","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-account-details/bankaccountdetailsreturnscreate","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"account-details-order#order-state-change","summary":"Account details order state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-account-details/eventaccountdetailsorderstatechange","deprecated":false},{"title":"account-details-payment#state-change","summary":"Account details payment state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-account-details/eventaccountdetailspaymentstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mcaAvailableCurrenciesGet","name":"Retrieve available currencies","isWebhook":false,"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve available currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all currencies that are available for balance accounts. This includes those that can have funds added from external accounts, as well as those that a balance can be held in.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/borderless-accounts-configuration/profiles/{profileId}/available-currencies","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/borderless-accounts-configuration/profiles/{profileId}/available-currencies","href":"multi-currency-account/mcaavailablecurrenciesget","openApiOperationId":"mcaAvailableCurrenciesGet","summary":"Retrieve available currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of currencies available for balance accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multi-currency-account/mcaavailablecurrenciesget"}],"panels":[]}]},"httpPath":"/borderless-accounts-configuration/profiles/{profileId}/available-currencies"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mcaPayinCurrenciesGet","name":"Retrieve payin currencies","isWebhook":false,"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve payin currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all currencies available for balance accounts that also support bank account details. You can use this list to create a balance account for the currency included and then subsequently create bank account details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/borderless-accounts-configuration/profiles/{profileId}/payin-currencies","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/borderless-accounts-configuration/profiles/{profileId}/payin-currencies","href":"multi-currency-account/mcapayincurrenciesget","openApiOperationId":"mcaPayinCurrenciesGet","summary":"Retrieve payin currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of currencies available for payin with bank account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760","exampleIds":["paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multi-currency-account/mcapayincurrenciesget"}],"panels":[]}]},"httpPath":"/borderless-accounts-configuration/profiles/{profileId}/payin-currencies"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mcaGet","name":"Retrieve multi currency account for a profile","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1multi-currency-account/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multi currency account for a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the multi-currency account details for the specified profile. If the user does not yet have a multi-currency account, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1multi-currency-account/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1multi-currency-account/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/multi-currency-account","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/multi-currency-account","href":"multi-currency-account/mcaget","openApiOperationId":"mcaGet","summary":"Retrieve multi currency account for a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Multi currency account object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}},"schemaId":"schema_761","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1multi-currency-account/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multi-currency-account/mcaget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/multi-currency-account"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mcaEligibilityGet","name":"Retrieve multi currency account eligibility","isWebhook":false,"pointer":"/paths/~1multi-currency-account~1eligibility/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve multi currency account eligibility","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check a profile, pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a query parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To check a specific location, pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using 2-letter ISO 3166 codes. If the country is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a valid 2-letter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter must also be passed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example (France): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v4/multi-currency-account/eligibility?country=FR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example (USA, California): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v4/multi-currency-account/eligibility?country=US&state=CA"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"profileId","in":"query","schemaId":"schema_650","description":"Profile ID to check eligibility for."},{"name":"country","in":"query","schemaId":"schema_639","description":"2-letter ISO 3166 country code to check eligibility for.","example":"FR"},{"name":"state","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2-letter state/province code. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CA"}],"pointer":"/paths/~1multi-currency-account~1eligibility/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1multi-currency-account~1eligibility/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/multi-currency-account/eligibility","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"profileId","in":"query","required":false,"schemaId":"schema_650"},{"name":"country","in":"query","required":false,"example":"FR","schemaId":"schema_639"},{"name":"state","in":"query","required":false,"example":"CA","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/multi-currency-account/eligibility","href":"multi-currency-account/mcaeligibilityget","openApiOperationId":"mcaEligibilityGet","summary":"Retrieve multi currency account eligibility"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Eligibility result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_762"}},"schemaId":"schema_762","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1multi-currency-account~1eligibility/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_762","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_762"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/multi-currency-account/mcaeligibilityget"}],"panels":[]}]},"httpPath":"/multi-currency-account/eligibility"}],"content":{"contentType":"group","meta":{"name":"multi-currency-account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Multi Currency Account","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Wise multi-currency account (MCA) enables users to hold, convert, and fund transfers (single or batches) with balances in up to 56 currencies. Of the 50+ currency balances supported, 10+ come with local account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/accounts/managing-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multi-currency account guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on the general use of the endpoints included below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/balance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balances APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/borderless-accounts-configuration/profiles/{profileId}/available-currencies","summary":"Retrieve available currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/multi-currency-account/mcaavailablecurrenciesget","deprecated":false},{"title":"/borderless-accounts-configuration/profiles/{profileId}/payin-currencies","summary":"Retrieve payin currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/multi-currency-account/mcapayincurrenciesget","deprecated":false},{"title":"/profiles/{profileId}/multi-currency-account","summary":"Retrieve multi currency account for a profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/multi-currency-account/mcaget","deprecated":false},{"title":"/multi-currency-account/eligibility","summary":"Retrieve multi currency account eligibility","prefix":{"name":"get","color":"get"},"badges":[],"link":"/multi-currency-account/mcaeligibilityget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetIncomingTransfer","name":"Get an incoming transfer","isWebhook":false,"pointer":"/paths/~1incoming-transfers~1{incomingTransferId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an incoming transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an incoming transfer by id. You can pull the incoming-transfer ID from the webhook payload."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]},{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"incomingTransferId","in":"path","schemaId":"schema_763","description":"Unique incoming transfer identifier. UUID-formatted string.","required":true}],"pointer":"/paths/~1incoming-transfers~1{incomingTransferId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1incoming-transfers~1{incomingTransferId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/incoming-transfers/{incomingTransferId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"incomingTransferId","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_763"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/incoming-transfers/{incomingTransferId}","href":"incoming-transfer/getincomingtransfer","openApiOperationId":"GetIncomingTransfer","summary":"Get an incoming transfer","securityGroups":[{"ClientCredentialsToken":[]},{"UserToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"GetIncomingTransfer 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIncomingTransferResponseContent","exampleIds":["paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer"]}},"schemaId":"components/schemas/GetIncomingTransferResponseContent","exampleIds":["paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"IncomingTransferNotFoundError 404 response","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1incoming-transfers~1{incomingTransferId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetIncomingTransferResponseContent","exampleIds":["paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetIncomingTransferResponseContent","exampleIds":["paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer"]}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-transfer/getincomingtransfer"}],"panels":[]}]},"httpPath":"/incoming-transfers/{incomingTransferId}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventIncomingTransferCredited","name":"Incoming transfer credited","isWebhook":true,"pointer":"/paths/incoming-transfer#credited/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming transfer credited","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when an incoming transfer is credited to a Wise balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a thin event, containing just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming_transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Fetch the full resource via the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/incoming-transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incoming transfer endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming-transfer#credited"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/incoming-transfer#credited/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"schemaId":"schema_764","pointer":"/paths/incoming-transfer#credited/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"incoming-transfer#credited","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_764"}},"responseCodes":["200"],"pointer":"incoming-transfer#credited","href":"incoming-transfer/eventincomingtransfercredited","openApiOperationId":"eventIncomingTransferCredited","summary":"Incoming transfer credited"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_764","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event. Returning other statuses will not change the incoming transfer's state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/incoming-transfer#credited/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-transfer/eventincomingtransfercredited"}],"panels":[]}]},"httpPath":"incoming-transfer#credited"}],"content":{"contentType":"group","meta":{"name":"incoming-transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming Transfers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incoming transfers are not publicly available. To get access, contact your Wise implementation manager."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An incoming transfer represents a payment received into a Wise balance via a supported payment rail (SWIFT, SEPA, Faster Payments, ACH, or the Wise network)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/incoming-transfers/{incomingTransferId}","summary":"Get an incoming transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incoming-transfer/getincomingtransfer","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"incoming-transfer#credited","summary":"Incoming transfer credited","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incoming-transfer/eventincomingtransfercredited","deprecated":false}]}]}]}]}},{"type":"separator","label":"Cards","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Card"},"seo":{"title":"Card"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Card"},"children":[]}]}]}},{"type":"link","label":"Permission","link":"/api-reference/card/permission","routeSlug":"/api-reference/card/permission","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Permission"},"seo":{"title":"Permission"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permission","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Permission"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardList","name":"List cards for a profile","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cards for a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of cards that belong to a specific profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile to retrieve cards for.","required":true,"example":123456}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_765","description":"The maximum number of cards to return per page. Must be between 10 and 100.","example":10},{"name":"pageNumber","in":"query","schemaId":"schema_766","description":"The page number to retrieve. Must be greater than or equal to 1.","example":1}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"}],"query":[{"name":"pageSize","in":"query","required":false,"example":10,"schemaId":"schema_765"},{"name":"pageNumber","in":"query","required":false,"example":1,"schemaId":"schema_766"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards","href":"card/cardlist","openApiOperationId":"cardList","summary":"List cards for a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of cards retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}},"schemaId":"schema_767","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_767","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/cardlist"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardGet","name":"Get card details","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves details for a specific card by its token.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards/{cardToken}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}","href":"card/cardget","openApiOperationId":"cardGet","summary":"Get card details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card details retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}},"schemaId":"components/schemas/Card","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Card","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/cardget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardStatusUpdate","name":"Update card status","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update card status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the status of a card. For cards issued with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, updating to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will activate the card and move the card order status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available status transitions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card is active and usable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card is temporarily frozen; all authorization requests will be declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"irreversibly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" blocked and is no longer usable"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_768","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_768","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/spend/profiles/{profileId}/cards/{cardToken}/status","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_768","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/status","href":"card/cardstatusupdate","openApiOperationId":"cardStatusUpdate","summary":"Update card status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_768","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_768","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card status updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}},"schemaId":"components/schemas/Card","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Card","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Card"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/cardstatusupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/status"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPinCountReset","name":"Reset PIN count","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1reset-pin-count/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset PIN count","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the wrong PIN has been entered more than 3 times, future transactions on the card will be blocked with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN_ENTRY_TRIES_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to reset the PIN count to 0 and unblock transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In some cases, you may also need to reset the PIN count directly at the ATM."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1reset-pin-count/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1reset-pin-count/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count","href":"card/cardpincountreset","openApiOperationId":"cardPinCountReset","summary":"Reset PIN count"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"PIN count reset successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1reset-pin-count/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/cardpincountreset"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPermissionsBulkUpdate","name":"Bulk update card permissions","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk update card permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable or disable multiple spending permissions on a card in a single request.\n\nThis is the recommended endpoint for updating card permissions as it allows updating multiple permissions atomically.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_769","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_769","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_769","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","422","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","href":"card/cardpermissionsbulkupdate","openApiOperationId":"cardPermissionsBulkUpdate","summary":"Bulk update card permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_769","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_769","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Permissions updated successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request. The requested permission type is not recognized.\nNo permissions are updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}},"schemaId":"schema_770","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"Unprocessable entity. The request is syntactically valid but cannot be fulfilled because\na requested permission is not supported by this card type, or the permission\nis locked and cannot be changed. No permissions are updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported","paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked"]}},"schemaId":"schema_771","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported","paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_770","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}}},{"code":"422","schemaId":"schema_771","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported","paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_771","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported","paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/cardpermissionsbulkupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardStatusChange","name":"Card status change","isWebhook":true,"pointer":"/paths/cards#card-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event is triggered for the initial card status as well as any subsequent updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_772"}},"schemaId":"schema_772","pointer":"/paths/cards#card-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_772"}},"responseCodes":["200"],"pointer":"cards#card-status-change","href":"card/eventcardscardstatuschange","openApiOperationId":"eventCardsCardStatusChange","summary":"Card status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_772","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_772"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/eventcardscardstatuschange"}],"panels":[]}]},"httpPath":"cards#card-status-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsManualProvisioningVerification","name":"Cards manual provisioning verification","isWebhook":true,"pointer":"/paths/cards#manual-provisioning-verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards manual provisioning verification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#manual-provisioning-verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#manual-provisioning-verification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"schemaId":"components/schemas/v2.0.0-12","pointer":"/paths/cards#manual-provisioning-verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#manual-provisioning-verification","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"responseCodes":["200"],"pointer":"cards#manual-provisioning-verification","href":"card/eventcardsmanualprovisioningverification","openApiOperationId":"eventCardsManualProvisioningVerification","summary":"Cards manual provisioning verification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/v2.0.0-12","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#manual-provisioning-verification/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card/eventcardsmanualprovisioningverification"}],"panels":[]}]},"httpPath":"cards#manual-provisioning-verification"}],"content":{"contentType":"group","meta":{"name":"card"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage your customers' cards programmatically. These APIs allow you to list cards, retrieve card details, control card status, and manage spending permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key capabilities:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List and retrieve card details for a profile"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update card status (active, frozen, blocked)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control spending permissions (e-commerce, ATM, contactless, magnetic stripe, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset PIN attempt counter after incorrect PIN entries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update card phone number for verification purposes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For accessing sensitive card data (PAN, CVV, PIN), see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-sensitive-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sensitive Card Details API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For ordering new cards, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Orders API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For transaction history, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Card","link":"/card/card","deprecated":false},{"title":"Permission","link":"/card/permission","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/cards","summary":"List cards for a profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card/cardlist","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}","summary":"Get card details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card/cardget","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/status","summary":"Update card status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/card/cardstatusupdate","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count","summary":"Reset PIN count","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card/cardpincountreset","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/spending-permissions","summary":"Bulk update card permissions","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/card/cardpermissionsbulkupdate","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cards#card-status-change","summary":"Card status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card/eventcardscardstatuschange","deprecated":false},{"title":"cards#manual-provisioning-verification","summary":"Cards manual provisioning verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card/eventcardsmanualprovisioningverification","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardEncryptionKeyGet","name":"Fetch RSA encryption key","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1clientSideEncryption~1fetchEncryptingKey/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch RSA encryption key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches Wise's RSA public key required for encrypting sensitive card data requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This key is used in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive card details flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create JWE (JSON Web Encryption) payloads."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1clientSideEncryption~1fetchEncryptingKey/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey","href":"card-sensitive-details/cardencryptionkeyget","openApiOperationId":"cardEncryptionKeyGet","summary":"Fetch RSA encryption key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"RSA encryption key retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_773"}},"schemaId":"schema_773","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1clientSideEncryption~1fetchEncryptingKey/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_773","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_773"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-sensitive-details/cardencryptionkeyget"}],"panels":[]}]},"httpPath":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardSensitiveDetailsGet","name":"Get sensitive card details","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1details/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get sensitive card details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches the card's Primary Account Number (PAN), security code (CVV2), expiry date, and cardholder name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires an encrypted JWE payload for security. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive card details guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for implementation details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve sensitive card details, the card must be in either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. A 403 response will be returned for cards in any other status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-tw-twcard-card-token","in":"header","schemaId":"schema_647","description":"The card token identifying which card to retrieve details for.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1details/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_774"}},"schemaId":"schema_774","pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1details/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twcard-data/v1/sensitive-card-data/details","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-tw-twcard-card-token","in":"header","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_774"}},"responseCodes":["200","429"],"pointer":"/twcard-data/v1/sensitive-card-data/details","href":"card-sensitive-details/cardsensitivedetailsget","openApiOperationId":"cardSensitiveDetailsGet","summary":"Get sensitive card details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"schemaId":"schema_774","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_774"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sensitive card details retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_775"}},"schemaId":"schema_775","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1details/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_775"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-sensitive-details/cardsensitivedetailsget"}],"panels":[]}]},"httpPath":"/twcard-data/v1/sensitive-card-data/details"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPinGet","name":"Get card PIN","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1pin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches the card's PIN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires an encrypted JWE payload for security. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive card details guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for implementation details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is SCA protected when applicable. If your profile is registered within the UK and/or EEA, SCA most likely applies. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-tw-twcard-card-token","in":"header","schemaId":"schema_647","description":"The card token identifying which card to retrieve the PIN for.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1pin/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_774"}},"schemaId":"schema_774","pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1pin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twcard-data/v1/sensitive-card-data/pin","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-tw-twcard-card-token","in":"header","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_774"}},"responseCodes":["200","429"],"pointer":"/twcard-data/v1/sensitive-card-data/pin","href":"card-sensitive-details/cardpinget","openApiOperationId":"cardPinGet","summary":"Get card PIN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"schemaId":"schema_774","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_774"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card PIN retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}},"schemaId":"schema_776","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1pin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-sensitive-details/cardpinget"}],"panels":[]}]},"httpPath":"/twcard-data/v1/sensitive-card-data/pin"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderPresetPin","name":"Set card PIN","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1preset-pin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set card PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this endpoint, make sure to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card order id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the headers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-tw-twcard-order-id","in":"header","schemaId":"schema_639","description":"The card order ID.","required":true,"example":"142"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1preset-pin/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_777"}},"schemaId":"schema_777","pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1preset-pin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twcard-data/v1/sensitive-card-data/preset-pin","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-tw-twcard-order-id","in":"header","required":true,"example":"142","schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_777"}},"responseCodes":["200","429"],"pointer":"/twcard-data/v1/sensitive-card-data/preset-pin","href":"card-sensitive-details/cardorderpresetpin","openApiOperationId":"cardOrderPresetPin","summary":"Set card PIN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"schemaId":"schema_777","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_777"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - PIN set successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_778"}},"schemaId":"schema_778","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1sensitive-card-data~1preset-pin/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_778","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_778"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-sensitive-details/cardorderpresetpin"}],"panels":[]}]},"httpPath":"/twcard-data/v1/sensitive-card-data/preset-pin"}],"content":{"contentType":"group","meta":{"name":"card-sensitive-details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sensitive Card Details","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise is a PCI DSS compliant provider and stores all card data securely. The scope for PCI compliance depends on your use case and will impact how you integrate. For all sensitive card details endpoints, follow the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detailed guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key capabilities:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access sensitive card data (PAN, CVV, PIN) via encrypted JWE payloads"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related operations:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For card management (list, status, permissions), see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cards API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ordering new cards, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Orders API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For transaction history, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transaction API"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/twcard-data/v1/clientSideEncryption/fetchEncryptingKey","summary":"Fetch RSA encryption key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-sensitive-details/cardencryptionkeyget","deprecated":false},{"title":"/twcard-data/v1/sensitive-card-data/details","summary":"Get sensitive card details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-sensitive-details/cardsensitivedetailsget","deprecated":false},{"title":"/twcard-data/v1/sensitive-card-data/pin","summary":"Get card PIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-sensitive-details/cardpinget","deprecated":false},{"title":"/twcard-data/v1/sensitive-card-data/preset-pin","summary":"Set card PIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-sensitive-details/cardorderpresetpin","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"3dsChallengeResultPost","name":"Inform challenge result","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~13dsecure~1challenge-result/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inform challenge result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must call this endpoint before the expiration time, otherwise it will return a 400 error. You can find the expiration information from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcards3dschallenge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3DS challenge webhook event"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the first call to this endpoint will be processed. Any subsequent duplicate requests will be ignored, although you will still receive a success response."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. For more information, please read "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business) associated with the 3DS challenge.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~13dsecure~1challenge-result/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~13dsecure~1challenge-result/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChallengeResultRequest"}},"schemaId":"components/schemas/ChallengeResultRequest","pointer":"/paths/~1spend~1profiles~1{profileId}~13dsecure~1challenge-result/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/3dsecure/challenge-result","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChallengeResultRequest"}},"responseCodes":["204","429"],"pointer":"/spend/profiles/{profileId}/3dsecure/challenge-result","href":"3ds/3dschallengeresultpost","openApiOperationId":"3dsChallengeResultPost","summary":"Inform challenge result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/ChallengeResultRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChallengeResultRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - Challenge result has been successfully recorded.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~13dsecure~1challenge-result/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3ds/3dschallengeresultpost"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/3dsecure/challenge-result"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCards3dsChallenge","name":"3DS challenge","isWebhook":true,"pointer":"/paths/cards#3ds-challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3DS challenge","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#3ds-challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#3ds-challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_779"}},"schemaId":"schema_779","pointer":"/paths/cards#3ds-challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#3ds-challenge","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_779"}},"responseCodes":["200"],"pointer":"cards#3ds-challenge","href":"3ds/eventcards3dschallenge","openApiOperationId":"eventCards3dsChallenge","summary":"3DS challenge"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_779","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_779"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#3ds-challenge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3ds/eventcards3dschallenge"}],"panels":[]}]},"httpPath":"cards#3ds-challenge"}],"content":{"contentType":"group","meta":{"name":"3ds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3D Secure Authentication","showPageActions":true},{"nodeType":"markdoc","content":"To manage certain aspects of the 3D Secure (3DS) authentication, you will need to integrate with the following APIs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/3dsecure/challenge-result","summary":"Inform challenge result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3ds/3dschallengeresultpost","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cards#3ds-challenge","summary":"3DS challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3ds/eventcards3dschallenge","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardKioskCollectionProduce","name":"Produce a card","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Produce a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends the card production request to a kiosk machine. To confirm that card information has been successfully created, listen to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcardscardproductionstatuschange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card-production-status-change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cards that were created over 60 days ago will result in a 422 error code and cannot be retried. This is due to the data being obfuscated on our side. In this case, a new card order has to be created."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business) that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_639","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_780"}},"schemaId":"schema_780","pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/spend/profiles/{profileId}/cards/{cardToken}/production","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_780"}},"responseCodes":["200","422","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/production","href":"card-kiosk-collection/cardkioskcollectionproduce","openApiOperationId":"cardKioskCollectionProduce","summary":"Produce a card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_780","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_780"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - The card information has been successfully sent to the kiosk machine.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"Unprocessable Content - The card information can't be processed by the kiosk machine. For more details, check the error code returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-kiosk-collection/cardkioskcollectionproduce"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/production"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardKioskCollectionProductionGet","name":"Retrieve card production status","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve card production status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current production status of a card at a kiosk machine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Subscribe to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcardscardproductionstatuschange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card production status change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook for real-time notifications. Use this endpoint only when you need to synchronously check the status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business) that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_639","description":"The unique token identifying the card.","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards/{cardToken}/production","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/production","href":"card-kiosk-collection/cardkioskcollectionproductionget","openApiOperationId":"cardKioskCollectionProductionGet","summary":"Retrieve card production status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved card production status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductionStatus","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-kiosk-collection/cardkioskcollectionproductionget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/production"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardProductionStatusChange","name":"Card production status change","isWebhook":true,"pointer":"/paths/cards#card-production-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card production status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KIOSK_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-kiosk-collection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card kiosk collection guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-production-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-production-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_781"}},"schemaId":"schema_781","pointer":"/paths/cards#card-production-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-production-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_781"}},"responseCodes":["200"],"pointer":"cards#card-production-status-change","href":"card-kiosk-collection/eventcardscardproductionstatuschange","openApiOperationId":"eventCardsCardProductionStatusChange","summary":"Card production status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_781","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_781"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-production-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-kiosk-collection/eventcardscardproductionstatuschange"}],"panels":[]}]},"httpPath":"cards#card-production-status-change"}],"content":{"contentType":"group","meta":{"name":"card-kiosk-collection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Kiosk Collection","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These APIs are designed to allow you to print and encrypt your card directly from a kiosk machine. The card information will be sent to our card manufacturer to configure and print the card on-site on a kiosk machine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card printing process will automatically begin once the request is received by our card manufacturer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During the printing process, you will be notified via webhook about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcardscardproductionstatuschange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card production status change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before using these APIs, make sure to read the guide on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-kiosk-collection#card-kiosk-collection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"kiosk collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please reach out to your Implementation Manager for more information on these APIs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In the sandbox environment, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationcardproduction"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card production simulation API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to test your integration with various production statuses and error scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-2":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production status flow "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These statuses represent the lifecycle of a card production:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is ready for production. The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"produce card endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be called."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is being produced at the kiosk machine (chip encryption and printing in progress)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card has been successfully produced and collected from the kiosk. This is a final state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCTION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card production failed. Check the errorCode to identify the issue, resolve it, then retry using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"produce card endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card with production status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will trigger an asynchronous call to update the associated card order to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Card production status flow","src":"/assets/card-production-status-flow.d5febc132f8e8c7d98835174afa64aa4ef9182140a5494f0f6df4167ed116f50.28b10c14.png"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/cards/{cardToken}/production","summary":"Produce a card","prefix":{"name":"put","color":"put"},"badges":[],"link":"/card-kiosk-collection/cardkioskcollectionproduce","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/production","summary":"Retrieve card production status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-kiosk-collection/cardkioskcollectionproductionget","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cards#card-production-status-change","summary":"Card production status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-kiosk-collection/eventcardscardproductionstatuschange","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CardOrder"},"seo":{"title":"Card Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Order","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CardOrder"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderCreate","name":"Create a card order","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a card order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new card order. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"program"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field value is retrieved from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-order/cardorderprogramsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve all card programs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request requires an extra field in the header, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-idempotence-uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This should be generated and used for any subsequent retries in the event that the initial request fails."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you issue a card under a business profile, the cardholder will automatically default to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profilebusinesscreatev5"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"business representative"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the cardholder is not the business representative, create a cardholder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/profile/profilepersonalcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personal profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and add the profileId of the cardholder profile to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the card order request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For country-specific address fields and validation rules, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/card-address-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card address validation guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-idempotence-uuid","in":"header","schemaId":"schema_647","description":"Idempotency key. Should be generated and used for any subsequent retries.","required":true,"example":"054064c9-e01e-49fb-8fd9-b0990b9442f4"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_782"}},"schemaId":"schema_782","pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/card-orders","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-idempotence-uuid","in":"header","required":true,"example":"054064c9-e01e-49fb-8fd9-b0990b9442f4","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_782"}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/card-orders","href":"card-order/cardordercreate","openApiOperationId":"cardOrderCreate","summary":"Create a card order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_782","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_782"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Card order created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardOrder"}},"schemaId":"components/schemas/CardOrder","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardOrder"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardordercreate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderList","name":"Retrieve all card orders","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all card orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of card orders created for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_628","description":"The maximum number of card orders to return per page. This number can be between 10 - 100, and will default to 10.","example":10},{"name":"pageNumber","in":"query","schemaId":"schema_628","description":"The page number to retrieve the next set of card orders. The number has to be greater or equal to 1, and will default to 1.","example":1}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/card-orders","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"}],"query":[{"name":"pageSize","in":"query","example":10,"schemaId":"schema_628"},{"name":"pageNumber","in":"query","example":1,"schemaId":"schema_628"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/card-orders","href":"card-order/cardorderlist","openApiOperationId":"cardOrderList","summary":"Retrieve all card orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved card orders.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}},"schemaId":"schema_783","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_783","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardorderlist"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderGet","name":"Retrieve a card order","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a card order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a card order based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456},{"name":"cardOrderId","in":"path","schemaId":"schema_650","description":"The card order ID.","required":true,"example":142}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/card-orders/{cardOrderId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardOrderId","in":"path","required":true,"example":142,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/card-orders/{cardOrderId}","href":"card-order/cardorderget","openApiOperationId":"cardOrderGet","summary":"Retrieve a card order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved card order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardOrder"}},"schemaId":"components/schemas/CardOrder","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardOrder"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardorderget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderProgramsGet","name":"Retrieve available card programs","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve available card programs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the list of available card programs for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1availability/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/card-orders/availability","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/card-orders/availability","href":"card-order/cardorderprogramsget","openApiOperationId":"cardOrderProgramsGet","summary":"Retrieve available card programs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved available card programs.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}},"schemaId":"schema_784","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_784","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_784"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardorderprogramsget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders/availability"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderRequirementsGet","name":"Retrieve card order requirements","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve card order requirements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all card requirements for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A valid card order needs all its requirements status to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of requirements are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN (optional)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-sensitive-details/cardorderpresetpin"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set a PIN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a virtual or physical card order. Contact the team if you need this feature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Verify your customer by providing KYC evidences. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Provide a valid address for your card order. Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-order/cardordervalidateaddress"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A requirement "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_INITIATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEEDS_ACTION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456},{"name":"cardOrderId","in":"path","schemaId":"schema_650","description":"The card order ID.","required":true,"example":142}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardOrderId","in":"path","required":true,"example":142,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements","href":"card-order/cardorderrequirementsget","openApiOperationId":"cardOrderRequirementsGet","summary":"Retrieve card order requirements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successfully retrieved card order requirements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785","exampleIds":["paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_785","exampleIds":["paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_785","exampleIds":["paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785","exampleIds":["paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardorderrequirementsget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements"},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderStatusUpdate","name":"Update card order status","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update card order status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of a card order based on its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardOrderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The status can be updated to one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (deprecated)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behaviour for card order cancellation differs across card order statuses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card order can be cancelled with no further action required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_DETAILS_CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card order can be cancelled, and its associated card will be blocked. However, the physical card may have already been produced and may be in delivery. If so, the card will still reach the end user's address. This should be communicated to the end user to prevent confusion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Card orders in these statuses cannot be cancelled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating a card order status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated. Check with our team whether this is supported in your integration."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID (personal or business).","required":true,"example":123456},{"name":"cardOrderId","in":"path","schemaId":"schema_650","description":"The card order ID.","required":true,"example":142}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1status/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_786"}},"schemaId":"schema_786","pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/status","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardOrderId","in":"path","required":true,"example":142,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_786"}},"responseCodes":["202","429"],"pointer":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/status","href":"card-order/cardorderstatusupdate","openApiOperationId":"cardOrderStatusUpdate","summary":"Update card order status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_786","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_786"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted - Card order status update has been accepted.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1status/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardorderstatusupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/status"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardOrderValidateAddress","name":"Validate an address","isWebhook":false,"pointer":"/paths/~1spend~1address~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate an address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the format of an address for a card order. Make sure to follow country-specific address fields and validation as described in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/card-address-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card address validation guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For card creation, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requirement depends on the card type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Physical Cards (Required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Used as the delivery address to ship the card and for AVS checks in countries where required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual Cards (Optional)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If provided, this acts as the billing address. If omitted, the profile address is used as the fallback. In either scenario, the address is used for AVS checks in countries where required."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We do not support PO BOX addresses."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1address~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_787"}},"schemaId":"schema_787","pointer":"/paths/~1spend~1address~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/address/validate","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_787"}},"responseCodes":["200","429"],"pointer":"/spend/address/validate","href":"card-order/cardordervalidateaddress","openApiOperationId":"cardOrderValidateAddress","summary":"Validate an address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_787","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_787"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Validation result returned. An empty errors collection means the address is valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_788","exampleIds":["paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_788","exampleIds":["paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1address~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_788","exampleIds":["paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_788","exampleIds":["paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/cardordervalidateaddress"}],"panels":[]}]},"httpPath":"/spend/address/validate"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardOrderStatusChange","name":"Card order status change","isWebhook":true,"pointer":"/paths/cards#card-order-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card order status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-order-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available card order statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The initial card order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on the requirement fulfillment state. The possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order is created. The card will be generated once it has fulfilled all the requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order has fulfilled all the requirements and the card should be generated in a short while."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_DETAILS_CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has been generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The physical card has been produced and is waiting to be picked up by delivery vendor (physical card only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has been activated and is ready to use. The card order is completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order has been cancelled. This can happen if you contact Wise Support to cancel a card order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery failed. The physical card has been returned and will be blocked (physical card only)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/card-order-status-flow.5dc3cd6580ca9beb1217ee786ebbd65a439ee722e9168a86b2b47b440ed09060.28b10c14.png","alt":"Create card order statuses transition diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-order-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"schemaId":"schema_789","pointer":"/paths/cards#card-order-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-order-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_789"}},"responseCodes":["200"],"pointer":"cards#card-order-status-change","href":"card-order/eventcardscardorderstatuschange","openApiOperationId":"eventCardsCardOrderStatusChange","summary":"Card order status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_789","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-order-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-order/eventcardscardorderstatuschange"}],"panels":[]}]},"httpPath":"cards#card-order-status-change"}],"content":{"contentType":"group","meta":{"name":"card-order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Orders","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this set of APIs, you will be able to create cards for your customers. You can also retrieve and view the status of your current card orders, as well as the list of available card programs for the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On production, each personal profile can order at most 1 physical card and 3 virtual cards. On sandbox, we allow up to 10 physical cards and 30 virtual cards for testing purpose. However, no more than 3 virtual cards can be ordered per day. This limit includes cards and card orders."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"card-order-status-flow","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card order status flow "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card order response will contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The initial status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on the requirement fulfillment state:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card order is created. The card will be generated once it has fulfilled all the requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card order has fulfilled all the requirements and the card should be generated in a short while"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_DETAILS_CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card has been generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The physical card has been produced and waiting to be picked up by delivery vendor (physical card only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card has been activated and is ready to use. The card order is completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card order has been cancelled. This can happen if you reach out to Wise Support to cancel a card order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delivery failed, the physical card has been returned and will be blocked (physical card only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Card order status state machine","src":"/assets/card-order-status-flow.5dc3cd6580ca9beb1217ee786ebbd65a439ee722e9168a86b2b47b440ed09060.28b10c14.png"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Card Order","link":"/card-order/cardorder","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/card-orders","summary":"Create a card order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-order/cardordercreate","deprecated":false},{"title":"/spend/profiles/{profileId}/card-orders","summary":"Retrieve all card orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-order/cardorderlist","deprecated":false},{"title":"/spend/profiles/{profileId}/card-orders/{cardOrderId}","summary":"Retrieve a card order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-order/cardorderget","deprecated":false},{"title":"/spend/profiles/{profileId}/card-orders/availability","summary":"Retrieve available card programs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-order/cardorderprogramsget","deprecated":false},{"title":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements","summary":"Retrieve card order requirements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-order/cardorderrequirementsget","deprecated":false},{"title":"/spend/profiles/{profileId}/card-orders/{cardOrderId}/status","summary":"Update card order status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/card-order/cardorderstatusupdate","deprecated":false},{"title":"/spend/address/validate","summary":"Validate an address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-order/cardordervalidateaddress","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cards#card-order-status-change","summary":"Card order status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-order/eventcardscardorderstatuschange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardTransactionGet","name":"Get card transaction","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get card transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a card transaction by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use in conjunction with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcardstransactionstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card transaction state change webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for versions V2.1.0 and later."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only transactions created in the past 90 days can be accessed. A 422 error code will be returned otherwise."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a refund happens, a separate transaction will be added with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"transactionId","in":"path","schemaId":"schema_650","description":"The ID of the transaction.","required":true,"example":342671}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1transactions~1{transactionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards/transactions/{transactionId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"transactionId","in":"path","required":true,"example":342671,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/transactions/{transactionId}","href":"card-transaction/cardtransactionget","openApiOperationId":"cardTransactionGet","summary":"Get card transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card transaction retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardTransaction"}},"schemaId":"components/schemas/CardTransaction","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardTransaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardTransaction"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-transaction/cardtransactionget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/transactions/{transactionId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardTransactionList","name":"List card transactions","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List card transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of card transactions for a specific card. Transactions are ordered by transaction ID in descending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use in conjunction with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventcardstransactionstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card transaction state change webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for versions V2.1.0 and later."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only transactions created in the past 90 days can be accessed. A 422 error code will be returned otherwise."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are not included in list responses. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction/cardtransactionget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get card transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve these fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile that owns the card.","required":true,"example":123456},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The unique token identifying the card.","required":true,"example":"59123122-223d-45f9-b840-0ad4a4f80937"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromCreationTime","in":"query","schemaId":"schema_742","description":"Start of range for transaction creation time in UTC, in ISO-8601 format.","required":true,"example":"2025-12-15T00:00:00Z"},{"name":"toCreationTime","in":"query","schemaId":"schema_742","description":"End of range for transaction creation time in UTC, in ISO-8601 format.","required":true,"example":"2026-01-15T00:00:10Z"},{"name":"pageSize","in":"query","schemaId":"schema_790","description":"Page size of query between 10 and 100 inclusive, defaults to 20.","example":10},{"name":"lastId","in":"query","schemaId":"schema_650","description":"A pagination cursor that marks your position in the list. Include the ID of the last transaction from the previous page to retrieve the next page (transactions with IDs less than the provided value).","example":342672}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards/{cardToken}/transactions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"59123122-223d-45f9-b840-0ad4a4f80937","schemaId":"schema_647"}],"query":[{"name":"fromCreationTime","in":"query","required":true,"example":"2025-12-15T00:00:00Z","schemaId":"schema_742"},{"name":"toCreationTime","in":"query","required":true,"example":"2026-01-15T00:00:10Z","schemaId":"schema_742"},{"name":"pageSize","in":"query","required":false,"example":10,"schemaId":"schema_790"},{"name":"lastId","in":"query","required":false,"example":342672,"schemaId":"schema_650"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/transactions","href":"card-transaction/cardtransactionlist","openApiOperationId":"cardTransactionList","summary":"List card transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card transactions retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_791","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_791","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_791","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_791","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-transaction/cardtransactionlist"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/transactions"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsTransactionStateChange","name":"Card transaction state change","isWebhook":true,"pointer":"/paths/cards#transaction-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card transaction state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered whenever a new card transaction occurs or is modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#transaction-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventcardstransactionstatechange/request/card-transaction/eventcardstransactionstatechange/request/transaction-categorisation","deepLinkHash":"/webhook-event/eventcardstransactionstatechange#webhook-event/eventcardstransactionstatechange/request/card-transaction/eventcardstransactionstatechange/request/transaction-categorisation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction categorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions can be categorized based on the guidelines below, though the results may not always be consistent."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active card check: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0 or 1 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.category.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not equal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6011"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATM balance check: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.category.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6011"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Authorisation: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_amount_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#transaction-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"schemaId":"schema_792","pointer":"/paths/cards#transaction-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#transaction-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_792"}},"responseCodes":["200"],"pointer":"cards#transaction-state-change","href":"card-transaction/eventcardstransactionstatechange","openApiOperationId":"eventCardsTransactionStateChange","summary":"Card transaction state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_792","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#transaction-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-transaction/eventcardstransactionstatechange"}],"panels":[]}]},"httpPath":"cards#transaction-state-change"}],"content":{"contentType":"group","meta":{"name":"card-transaction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve information on transactions made on your users' cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"card-transaction-type","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction types "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving money on the card, excluding Visa OCT or Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sending money to another card or e-wallet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cash disbursement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Visa OCT and Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Online purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Purchase via a POS terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partial or full refund of an existing card transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"card-transaction-state","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction states "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been authorized but not captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been captured and/or settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default fallback status if the state cannot be confirmed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transition from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an edge case. Wise releases the customer funds after 7 days (30 days for pre-authorization) if the merchant has not captured the transaction, and the state becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". However, the merchant can decide to capture the transaction at a later date, at which point the state will become "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Transaction state flow","src":"/assets/transaction-state-flow.4bc661fe8d27620f26195dc780a163db3505a445baf25a40be57fe04cf7d44ae.28b10c14.png"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"card-transaction-decline-reasons","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline reasons "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The decline reason field provides information about the specific issue that led to the transaction being declined, helping the merchant and the customer troubleshoot the problem."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While the decline reason field provides valuable information, it may not cover all possible reasons for a decline, such as technical issues or unforeseen circumstances."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New decline reasons may be added in the future, and not all decline reasons are currently documented. Review this documentation regularly to ensure accuracy."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exercise caution when communicating decline reasons to your customers, as some may not be relevant or may cause confusion."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Balance related to the transaction is not active. Ensure that all outstanding actions have been completed before using the card, as this may help avoid potential issues or declines"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been declined pending further compliance checks. It may have been flagged for potential sanctions issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_PIN_CHANGE_NOT_ALLOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PIN change via ATM terminal is not allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED_COUNTRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transactions were made in unsupported countries. Check this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2935771/where-can-i-use-my-wise-card"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see if the country is included in the list of supported nations. It is possible for a merchant to be based in a supported country and have an address registered in a blocked country, albeit infrequently"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED_SUBSCRIPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The system cannot facilitate this transaction as the customer has opted out of recurring payments with this merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card provided has reached its expiration date, making it invalid for this transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer or the customer service team has put this card on a temporary hold. If the card has not been frozen by the customer, it may be worth investigating further. To resume spending, advise the customer to unfreeze the card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card is either not active or has not been received by the customer, so the transaction cannot proceed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card has been blocked and cannot be used anymore"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_PARTNER_SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The internal team has deactivated the account for compliance reasons related to AML, fraud, or EDD. Contact the team if this is believed to be an error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHIP_PIN_ENTRY_TRIES_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The PIN is restricted on the chip of the card due to excessive incorrect entries. The blocked PIN can be unlocked at an ATM using specific steps that vary depending on the machine and country, such as PIN management or PIN operations followed by unblocking the PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONNECTION_ISSUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - A connection problem occurred during the transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTACTLESS_PIN_ENTRY_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contactless payment systems sometimes require a PIN for authentication purposes to protect users' accounts from potential fraud or tampering. In Europe, contactless payment transactions that follow one after the other require PIN verification as an additional security measure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTIONS_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Credit is not supported for this specific transaction. Review the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/gb/legal/acceptable-use-policy-eea"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable Use Policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for further information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUMULATIVE_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - In certain jurisdictions, there are restrictions on the amount that can be spent. Refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2899986/what-are-my-spending-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spending limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for further details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED_ADVICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There is a problem with the message from the processor, so it might not be accepted because it could be incomplete or unsafe. This does not indicate a problem with the card. Advise the customer that there was a technical issue with the payment and to try again later"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_CVV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer entered the wrong security code. Advise the customer to check their card details and try again. If the saved card details are correct, they should remove their card details from the merchant's website and add them back again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_EXPIRY_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer entered the wrong expiration date for their card. If the saved card details are correct, they should remove their card details from the merchant's website and add them back again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_PIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer entered their PIN incorrectly. Advise the customer to check their PIN and try again. If the PIN is correct and still fails, suggest resetting the PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSUFFICIENT_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer does not have enough money in their account to make the payment. Advise the customer to add money to their account and try again. In most cases, this will resolve the issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_3DS_UCAF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The 3D Secure checks failed during the transaction. The customer should try again and request authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_ARQC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ARQC (Authorization Request Cryptogram) is a cryptogram generated by the card during a transaction, which is validated on the server side. If incorrect, it could indicate a faulty card, a fraudulent attack, or an issue with the POS terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_ICVV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ICVV (Integrated Circuit Card Verification Value) is a security feature used to validate the authenticity of a card during chip-based transactions. There were problems reading the chip on the card, which may indicate an issue with the card's chip, the terminal, or the transaction process. Wait and try again"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_MERCHANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction from a specific merchant is declined by scheme. The merchant should clarify the exact cause with the scheme"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Certain types of transactions are not supported. The customer should ask the merchant to use a different payment method or try a different merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANDATE_DCC_NON_SUPPORTED_FOR_CARD_COUNTRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction was declined because the system does not support conversions for Brazilian cards when BRL is involved. BRL will not be automatically exchanged to other currencies. If the customer wants to continue with the payment, they need to change the currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANDATE_LOCAL_CASH_WITHDRAWAL_NOT_ALLOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawal services are not provided in the country where the transaction is taking place"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_SUPPORTED_CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The currency in this transaction is not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_SUPPORTED_MCC_FOR_COUNTRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transactions in this category are not supported for customers in the country of purchase. Consider using an alternative payment method or changing merchant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_DAILY_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached the daily spending limit for the card or their profile. Advise if they would like to update "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitsprofileupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_LIFETIME_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached the lifetime spending limit. Advise if they would like to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"increase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" their lifetime limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_MONTHLY_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached the monthly spending limit for the card or their profile. Advise if they would like to update "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitsprofileupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_NOT_ALLOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This payment type has been disabled. Advise if they would like to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card/cardpermissionsbulkupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_TRANSACTION_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has exceeded the transaction limit for the card. Advise if they would like to update their "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN_ENTRY_TRIES_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached the maximum number of allowed online PIN entry attempts. Consider implementing a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card/cardpincountreset"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reset PIN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature within the app to help the customer regain access to their card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRE_ACTIVATED_CARD_PIN_ENTRY_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has attempted to make a contactless payment at a POS or ATM, but their card has not been activated for chip and PIN transactions. To modify the card activation strategy for all cards, contact the implementation manager"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The system is currently experiencing technical difficulties. Advise the customer to try again after a brief period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESTRICTED_MODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Although rare, restricted mode can occur. Advise the customer to replace their card promptly as the system should have already informed them. In this mode, more secure payment methods like chip and PIN, contactless, mobile wallets, and online payments with 3DS are allowed, while less secure methods like magnetic stripe and online payments without 3DS are not permitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL_NOT_MATCHING_AUTH_CURRENCY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant has issued a reversal instruction for a different currency than what was originally requested during the authorization process"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_SOFT_DECLINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction cannot proceed due to SCA regulations. Suggest the customer contact the merchant and use a more secure authentication method such as 3DS. For example, the customer can try chip and PIN, or a mobile wallet like Apple Pay or Google Pay"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEME_BLOCKED_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This transaction has been flagged by the scheme and cannot be processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_CVM_FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The system has detected that the POS terminal was misconfigured and failed security checks. Suggest the customer use an alternative payment method like contactless or mobile wallets, or recommend asking the merchant to accept a signature instead"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_MAGSTRIPE_SECURE_ELEMENTS_INCORRECT_OR_MISSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The merchant has entered the wrong type of purchase. Advise the customer to contact the merchant and ask them to correct this issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_PIN_ENTRY_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - To proceed with this transaction, the customer is required to enter their PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This transaction has been labeled as high-risk by Wise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_AML"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This transaction has been flagged as high-risk based on AML compliance protocols. This reason cannot be disclosed to end customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_COMPLIANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The compliance system has flagged this transaction as high-risk. This reason cannot be disclosed to end customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_CORE_FRAUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This transaction has been blocked based on fraud policies and procedures"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_SANCTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This transaction has been flagged as high-risk based on sanctions list analysis. This reason cannot be disclosed to end customers. This classification is final and cannot be appealed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_SOFT_DECLINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This e-commerce transaction cannot be processed due to high risk factors. The merchant must complete 3DS before the transaction can be approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSACTION_TYPE_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There are restrictions on this type of transaction, and sometimes the scheme will not allow it. Check if "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"spend control"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set up to block this transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNEXPECTED_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There may have been a communication error between the merchant's system and the server, but the POS system may have already notified the user of this issue"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"card-transaction-detailed-decline-reasons","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed decline reasons "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed decline reasons provide secondary level information for certain decline reasons, adding more context to transaction failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please be aware that new detailed decline reasons may be added in the future, and not all reasons are currently documented. Therefore, it is important to exercise caution and regularly review the documentation to ensure accuracy."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please exercise caution when communicating reasons to your customers, as some may not be relevant or may cause confusion. If you have any questions or concerns, we are here to assist you."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSUFFICIENT_FUNDS_FOR_BLOCKED_SMART_CONVERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction was declined due to insufficient balance in transaction currency when smart conversion feature is disabled (e.g. BRL cards). The customer needs to convert their funds to the transaction currency and try again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSUFFICIENT_FUNDS_FOR_SPECIFIC_CURRENCY_RESERVATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction will be declined with this reason if the customer's card is issued in a region subject to smart conversion limitations, and the transaction currency is the limited currency but the customer doesn't hold enough of that currency. Other currencies won't be automatically converted to the limited currency. The customer needs to convert their funds to the transaction currency before retrying the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_NO_BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer might be abusing merchants by saving a card without having any balance to cover upcoming charges from them. The customer will need to top up their account to cover any charges from the merchant at a later date before re-attempting the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESET_YOUR_PIN_AT_ATM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - There's a problem with how Chip was read and we had to decline the transaction. The customer will need to reset their PIN at an ATM."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCORRECT_CVV2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid CVV2 was provided. The customer needs to check their saved card details and if they're correct, they should remove and add their card details to the merchant's website again. If this doesn't help, they could try to use their card at another merchant's website. If the same issue happens, they'll need to order a new card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_SOFT_DECLINE_CONTACTLESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contactless transaction could not be approved due to SCA regulations. The customer should perform at least one PIN transaction or use an ATM to reset PIN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD_REVIEW_ACTIVITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - We couldn't confirm all transactions in the customer's activity were done by them, so we froze their card. The customer should review recent transactions and unfreeze the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_TRANSACTION_TYPE_FINAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This decline reason is used for unmapped processor or network error codes, indicating an external system issue or unclassified response. The decision authority on the transaction information identifies a SCHEME decline, which may relate to card usage in unsupported countries. The customer will need to use an alternative payment method to complete this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_TRANSACTION_TYPE_CONTACTLESS_MAGSTRIPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The POS terminal used a deprecated and not secure way to transmit card data. The customer will need to use another POS machine or try another payment method (Chip and PIN or Mobile Wallet)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_TRANSACTION_TYPE_FALLBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The chip couldn't be read due to a technical issue which resulted in the transaction \"falling back\" to magnetic stripe. As damaging the chip (so it would fall back to stripe) is a common way of fraud, these types of transactions are often deemed risky and being blocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer will need to:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try again or try a different terminal / ATM if it still doesn't work"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use another payment method, e.g. Contactless"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use another card"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the issue persists with multiple terminals, they'll need to replace their card as it may be damaged"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTACTLESS_DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_CONTACTLESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission (contactless payments) is disabled. The customer will need to enable the permission to allow contactless transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission (online payments) is disabled. The customer will need to enable the permission to allow e-commerce transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHIP_DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_CHIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission (Chip transactions) is disabled. The customer will need to enable the permission to allow Chip transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAGSTRIPE_DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_MAGSTRIPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission (magnetic stripe transactions) is disabled. The customer will need to enable the permission to allow magnetic stripe transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WALLET_DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE_WALLETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission is disabled. The customer will need to enable the permission to allow mobile wallet transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROFILE_GENERAL_DAILY_LIMIT_EXCEEDED_CHANGEABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached their daily total account limit (profile-level). The customer will need to edit the limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROFILE_GENERAL_MONTHLY_LIMIT_EXCEEDED_CHANGEABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has gone over their monthly total account limit (profile-level). The customer will need to edit the limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_GENERAL_DAILY_LIMIT_EXCEEDED_CHANGEABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has reached their daily limit for this card (card-level). The customer will need to edit the limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_GENERAL_MONTHLY_LIMIT_EXCEEDED_CHANGEABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer has gone over the monthly limit for this card (card-level). The customer will need to edit the limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_METHOD_MAX_MONTHLY_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card's maximum non-changeable monthly spending limit has been reached. The customer will need to wait until the start of the next calendar month to perform transactions again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - This decline reason is used when the processor or network returns an error code that is not mapped to any of our specific detailed decline reasons. This can be caused by various external system issues or unclassified processor responses."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/cards/transactions/{transactionId}","summary":"Get card transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-transaction/cardtransactionget","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/transactions","summary":"List card transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-transaction/cardtransactionlist","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cards#transaction-state-change","summary":"Card transaction state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/card-transaction/eventcardstransactionstatechange","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"profile-limits"},"seo":{"title":"Profile Limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile Limits","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/profile-limits"},"children":[]}]}]}},{"type":"link","label":"Card Limits","link":"/api-reference/spend-limits/card-limits","routeSlug":"/api-reference/spend-limits/card-limits","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"card-limits"},"seo":{"title":"Card Limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Limits","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/card-limits"},"children":[]}]}]}},{"type":"link","label":"Card Holder Limits","link":"/api-reference/spend-limits/card-holder-limits","routeSlug":"/api-reference/spend-limits/card-holder-limits","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"card-holder-limits"},"seo":{"title":"Card Holder Limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Holder Limits","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/card-holder-limits"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsProfileGet","name":"Retrieve profile limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve profile limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the spend limits that are configured for a profile.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/spend-limits","href":"spend-limits/spendlimitsprofileget","openApiOperationId":"spendLimitsProfileGet","summary":"Retrieve profile limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Profile spend limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_793","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_793","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_793","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_793","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitsprofileget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsProfileUpdate","name":"Update profile limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update profile limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update profile daily and monthly spend limits for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both daily and monthly must be set."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_794","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_794","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/spend/profiles/{profileId}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_794","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/spend-limits","href":"spend-limits/spendlimitsprofileupdate","openApiOperationId":"spendLimitsProfileUpdate","summary":"Update profile limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_794","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_794","exampleIds":["paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated profile spend limits. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitsprofileget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve profile limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitsprofileupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardGet","name":"Retrieve card limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve card limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the spend limits that are configured for a card.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_639","description":"The card token.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","href":"spend-limits/spendlimitscardget","openApiOperationId":"spendLimitsCardGet","summary":"Retrieve card limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card spend limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-limits"}},"schemaId":"components/schemas/card-limits","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/card-limits","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-limits"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscardget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardUpdate","name":"Create or update card limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update card limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update card transaction, daily, monthly or lifetime spend limits.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_639","description":"The card token.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_795","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_795","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_795","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","href":"spend-limits/spendlimitscardupdate","openApiOperationId":"spendLimitsCardUpdate","summary":"Create or update card limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_795","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_795","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated card spend limits. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve card limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscardupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardDelete","name":"Delete card limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits~1{granularity}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete card limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete card spend limits for a specific granularity.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_639","description":"The card token.","required":true},{"name":"granularity","in":"path","schemaId":"schema_796","description":"The limit granularity to delete.","required":true}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits~1{granularity}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits~1{granularity}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_639"},{"name":"granularity","in":"path","required":true,"schemaId":"schema_796"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}","href":"spend-limits/spendlimitscarddelete","openApiOperationId":"spendLimitsCardDelete","summary":"Delete card limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated card spend limits. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve card limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits~1{granularity}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscarddelete"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardHolderGet","name":"Retrieve cardholder limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve cardholder limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the spend limits that are configured for a cardholder. These\nlimits apply across all cards belonging to that cardholder, not to an\nindividual card.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessProfileId","in":"path","schemaId":"schema_650","description":"The business profile ID.","required":true},{"name":"cardHolderProfileId","in":"path","schemaId":"schema_650","description":"The personal profile ID of the cardholder.","required":true}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"businessProfileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardHolderProfileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","403","422","429","500"],"pointer":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","href":"spend-limits/spendlimitscardholderget","openApiOperationId":"spendLimitsCardHolderGet","summary":"Retrieve cardholder limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cardholder spend limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-holder-limits"}},"schemaId":"components/schemas/card-holder-limits","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client lacks the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARDS_API_VIEW_SPENDING_LIMITS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the business profile, or the cardholder profile is not accessible to it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A path parameter references a profile of the wrong type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference a business profile and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference a personal profile."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"An unexpected error occurred.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/card-holder-limits","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-holder-limits"}}},{"code":"403","schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscardholderget"}],"panels":[]}]},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardHolderUpdate","name":"Create or update cardholder limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update cardholder limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or update daily and monthly spend limits for a cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" limit type is supported for cardholder limits.Any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is rejected with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422. When no limits are configured yet, both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daily"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplied. Once limits exist, either window can be updated on its own."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessProfileId","in":"path","schemaId":"schema_650","description":"The business profile ID.","required":true},{"name":"cardHolderProfileId","in":"path","schemaId":"schema_650","description":"The personal profile ID of the cardholder.","required":true}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_797","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_797","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"businessProfileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardHolderProfileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_797","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","422","429","500"],"pointer":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","href":"spend-limits/spendlimitscardholderupdate","openApiOperationId":"spendLimitsCardHolderUpdate","summary":"Create or update cardholder limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_797","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_797","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated cardholder spend limits. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-limits/spendlimitscardholderget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve cardholder limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-holder-limits"}},"schemaId":"components/schemas/card-holder-limits","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be processed. Returned when a required field is absent ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aggregateWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a window's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aggregateWindow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains neither "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daily"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when a path parameter is not a valid integer, or when the body cannot be parsed. Field-level detail is provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where available; for unparseable bodies the array is empty."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody"]}},"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client lacks the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARDS_API_MANAGE_SPENDING_LIMITS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the business profile, or the cardholder profile is not accessible to it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is valid JSON but cannot be processed. A 422 is deterministic and actionable: the same request will fail the same way until the offending value is changed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array identifies the parameter or field that caused the error. There are three cases, shown below."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch"]}},"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"An unexpected error occurred.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/card-holder-limits","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/card-holder-limits"}}},{"code":"400","schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody"]}}},{"code":"403","schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits","paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscardholderupdate"}],"panels":[]}]},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendLimitsCardHolderDelete","name":"Remove cardholder limits","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove cardholder limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all configured spend limits for a cardholder. Both the daily and\nmonthly windows are removed together; individual windows cannot be removed\nseparately.\n\nSucceeds whether or not limits are currently configured.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"businessProfileId","in":"path","schemaId":"schema_650","description":"The business profile ID.","required":true},{"name":"cardHolderProfileId","in":"path","schemaId":"schema_650","description":"The personal profile ID of the cardholder.","required":true}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"businessProfileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardHolderProfileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","403","422","429","500"],"pointer":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","href":"spend-limits/spendlimitscardholderdelete","openApiOperationId":"spendLimitsCardHolderDelete","summary":"Remove cardholder limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Spend limits removed. No response body.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client lacks the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARDS_API_MANAGE_SPENDING_LIMITS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the business profile, or the cardholder profile is not accessible to it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A path parameter references a profile of the wrong type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference a business profile and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardHolderProfileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must reference a personal profile."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"An unexpected error occurred.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/access-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/validation-error-2","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/server-error","exampleIds":["paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-limits/spendlimitscardholderdelete"}],"panels":[]}]},"httpPath":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits"}],"content":{"contentType":"group","meta":{"name":"spend-limits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend Limits","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage spending limits applied to profiles and cards. Profile limits are shared across all cards under the same profile, while card limits apply to individual cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details on how profile and card limits interact, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-management#spend-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card management guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Profile Limits","link":"/spend-limits/profile-limits","deprecated":false},{"title":"Card Limits","link":"/spend-limits/card-limits","deprecated":false},{"title":"Card Holder Limits","link":"/spend-limits/card-holder-limits","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/spend-limits","summary":"Retrieve profile limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-limits/spendlimitsprofileget","deprecated":false},{"title":"/spend/profiles/{profileId}/spend-limits","summary":"Update profile limits","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/spend-limits/spendlimitsprofileupdate","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","summary":"Retrieve card limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-limits/spendlimitscardget","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits","summary":"Create or update card limits","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/spend-limits/spendlimitscardupdate","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/spend-limits/{granularity}","summary":"Delete card limits","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/spend-limits/spendlimitscarddelete","deprecated":false},{"title":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","summary":"Retrieve cardholder limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-limits/spendlimitscardholderget","deprecated":false},{"title":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","summary":"Create or update cardholder limits","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/spend-limits/spendlimitscardholderupdate","deprecated":false},{"title":"/spend/profiles/{businessProfileId}/card-holder-profiles/{cardHolderProfileId}/spend-limits","summary":"Remove cardholder limits","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/spend-limits/spendlimitscardholderdelete","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"rule"},"seo":{"title":"Authorisation Rule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorisation Rule","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/rule"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsRuleCreate","name":"Add a new authorisation rule","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new authorisation rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an authorisation rule. It won't be enabled unless it is "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls/spendcontrolsruleapply"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALLOW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rule permits only the transactions that match the specified criteria and blocks all others. For instance, a rule allowing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SGD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions will block all transactions that are not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SGD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_798","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_798","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/applications/{clientId}/spend-controls/rules","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_798","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules","href":"spend-controls/spendcontrolsrulecreate","openApiOperationId":"spendControlsRuleCreate","summary":"Add a new authorisation rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_798","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_798","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created rule.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rule"}},"schemaId":"components/schemas/rule","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/rule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/rule"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsrulecreate"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsRulesList","name":"List all authorisation rules","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all authorisation rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the existing authorisation rules, regardless of whether or not they are applied.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/applications/{clientId}/spend-controls/rules","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules","href":"spend-controls/spendcontrolsruleslist","openApiOperationId":"spendControlsRulesList","summary":"List all authorisation rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of authorisation rules.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_799","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_799","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_799","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_799","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsruleslist"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsRuleApply","name":"Apply an authorisation rule","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply an authorisation rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Apply an authorisation rule. This will result in the rule being evaluated against every incoming card authorisation request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/applications/{clientId}/spend-controls/rules/apply","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules/apply","href":"spend-controls/spendcontrolsruleapply","openApiOperationId":"spendControlsRuleApply","summary":"Apply an authorisation rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule applied successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsruleapply"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/apply"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsRuleUnapply","name":"Unapply an authorisation rule","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unapply an authorisation rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates an authorisation rule. This will result in all card transactions "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being evaluated against this rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule still "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls/spendcontrolsruleslist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exists"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls/spendcontrolsruleapply"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/applications/{clientId}/spend-controls/rules/unapply","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules/unapply","href":"spend-controls/spendcontrolsruleunapply","openApiOperationId":"spendControlsRuleUnapply","summary":"Unapply an authorisation rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule unapplied successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsruleunapply"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/unapply"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsAppliedRulesList","name":"List applied authorisation rules","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List applied authorisation rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of all the active authorisation rules that have been applied.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/applications/{clientId}/spend-controls/rules/applied","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules/applied","href":"spend-controls/spendcontrolsappliedruleslist","openApiOperationId":"spendControlsAppliedRulesList","summary":"List applied authorisation rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of applied rule IDs.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_801","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_801","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_801","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_801","exampleIds":["paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsappliedruleslist"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/applied"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"spendControlsRuleDelete","name":"Delete an authorisation rule","isWebhook":false,"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1{ruleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an authorisation rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an authorisation rule that is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently not applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rule is applied, you should "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls/spendcontrolsruleunapply"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unapply"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the rule before deleting it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_639","description":"The application client ID.","required":true},{"name":"ruleId","in":"path","schemaId":"schema_650","description":"The ID of the authorisation rule to delete.","required":true}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1{ruleId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1{ruleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/spend/applications/{clientId}/spend-controls/rules/{ruleId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"schemaId":"schema_639"},{"name":"ruleId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/applications/{clientId}/spend-controls/rules/{ruleId}","href":"spend-controls/spendcontrolsruledelete","openApiOperationId":"spendControlsRuleDelete","summary":"Delete an authorisation rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule deleted successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1{ruleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/spendcontrolsruledelete"}],"panels":[]}]},"httpPath":"/spend/applications/{clientId}/spend-controls/rules/{ruleId}"}],"content":{"contentType":"group","meta":{"name":"spend-controls"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend Controls","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control which card transactions are permitted by creating rules based on merchant category code (MCC) or transaction currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorisation rule dictates whether transactions should be declined or approved based on a pre-determined set of rules. A transaction can only pass if it satisfies all the applied rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a rule has no practical implication until it is "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/spend-controls/spendcontrolsruleapply"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Applying a rule results in the authorisation rule being evaluated against every incoming card authorisation request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules are scoped at the application level. Use a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client credentials token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to call these endpoints."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Authorisation Rule","link":"/spend-controls/rule","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/applications/{clientId}/spend-controls/rules","summary":"Add a new authorisation rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend-controls/spendcontrolsrulecreate","deprecated":false},{"title":"/spend/applications/{clientId}/spend-controls/rules","summary":"List all authorisation rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-controls/spendcontrolsruleslist","deprecated":false},{"title":"/spend/applications/{clientId}/spend-controls/rules/apply","summary":"Apply an authorisation rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend-controls/spendcontrolsruleapply","deprecated":false},{"title":"/spend/applications/{clientId}/spend-controls/rules/unapply","summary":"Unapply an authorisation rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend-controls/spendcontrolsruleunapply","deprecated":false},{"title":"/spend/applications/{clientId}/spend-controls/rules/applied","summary":"List applied authorisation rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-controls/spendcontrolsappliedruleslist","deprecated":false},{"title":"/spend/applications/{clientId}/spend-controls/rules/{ruleId}","summary":"Delete an authorisation rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/spend-controls/spendcontrolsruledelete","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pushProvisioningPaymentTokensList","name":"List payment tokens for a card","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List payment tokens for a card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You have the option to obtain the payment tokens associated with a card, which can assist in determining if it's already linked to a specific wallet.\nNote that the payment token status associated with the card may not be accurate (for example, after a phone factory reset).\nTherefore, it's advisable to consistently check the wallet instance for the most up-to-date token status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true,"example":12345},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"schemaId":"schema_802","pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_802"}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens","href":"digital-wallet/pushprovisioningpaymenttokenslist","openApiOperationId":"pushProvisioningPaymentTokensList","summary":"List payment tokens for a card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_802","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_802"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns all the payment tokens except deactivated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_803","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_803","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_803","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_803","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/digital-wallet/pushprovisioningpaymenttokenslist"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"digitalWalletActivatePaymentToken","name":"Manual provisioning payment token activation","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual provisioning payment token activation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint activates the payment token for a card that has been manually added to a wallet provider. Please read this "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-digital-wallet"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before implementing this API."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is not available for sandbox testing."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID","required":true,"example":12345},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa"},{"name":"paymentTokenUniqueReference","in":"path","schemaId":"schema_639","description":"The payment token unique reference issued by the scheme token service","required":true,"example":"DNITHE382607223583426199"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_804","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_804","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","schemaId":"schema_647"},{"name":"paymentTokenUniqueReference","in":"path","required":true,"example":"DNITHE382607223583426199","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_804","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","403","404","429","500"],"pointer":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation","href":"digital-wallet/digitalwalletactivatepaymenttoken","openApiOperationId":"digitalWalletActivatePaymentToken","summary":"Manual provisioning payment token activation","securityGroups":[{"UserToken":[]},{"ClientCredentialsToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_804","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_804","exampleIds":["paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - Payment token have been successfully activated or declined","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}},"schemaId":"schema_805","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_806"}},"schemaId":"schema_806","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_807"}},"schemaId":"schema_807","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"Server side error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_808"}},"schemaId":"schema_808","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_805","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}}},{"code":"403","schemaId":"schema_806","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_806"}}},{"code":"404","schemaId":"schema_807","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_807"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"schema_808","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_808"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/digital-wallet/digitalwalletactivatepaymenttoken"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pushProvisioningGooglePayGet","name":"Push provisioning for Google Pay","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1google-pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Push provisioning for Google Pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns encrypted cardholder information and other metadata needed for Google Pay push provisioning."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is not available for sandbox testing."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-tw-twcard-card-token","in":"header","schemaId":"schema_647","description":"The card token identifying which card to retrieve push provisioning data for.","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1google-pay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_809"}},"schemaId":"schema_809","pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1google-pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-tw-twcard-card-token","in":"header","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_809"}},"responseCodes":["200","429"],"pointer":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay","href":"digital-wallet/pushprovisioninggooglepayget","openApiOperationId":"pushProvisioningGooglePayGet","summary":"Push provisioning for Google Pay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"schemaId":"schema_809","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_809"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Encrypted cardholder information for Google Pay.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_810"}},"schemaId":"schema_810","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1google-pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_810"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/digital-wallet/pushprovisioninggooglepayget"}],"panels":[]}]},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pushProvisioningApplePayGet","name":"Push Provisioning for Apple Pay","isWebhook":false,"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1apple-pay/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Push Provisioning for Apple Pay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns encrypted cardholder information and other metadata needed for Apple Pay push provisioning."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is not available for sandbox testing."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-tw-twcard-card-token","in":"header","schemaId":"schema_647","description":"The card token identifying which card to retrieve push provisioning data for.","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1apple-pay/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_811"}},"schemaId":"schema_811","pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1apple-pay/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay","servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-tw-twcard-card-token","in":"header","required":true,"example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","schemaId":"schema_647"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_811"}},"responseCodes":["200","429"],"pointer":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay","href":"digital-wallet/pushprovisioningapplepayget","openApiOperationId":"pushProvisioningApplePayGet","summary":"Push Provisioning for Apple Pay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://twcard.wise.com","description":"Production Environment"},{"url":"https://twcard.wise-sandbox.com","description":"Sandbox Environment"}],"schemaId":"schema_811","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_811"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Encrypted cardholder information for Apple Pay.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}},"schemaId":"schema_812","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1twcard-data~1v1~1push-provisioning~1encrypted-payload~1apple-pay/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_812","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/digital-wallet/pushprovisioningapplepayget"}],"panels":[]}]},"httpPath":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay"}],"content":{"contentType":"group","meta":{"name":"digital-wallet"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Digital Wallet","showPageActions":true},{"nodeType":"markdoc","content":"These APIs provide encrypted cardholder information needed to implement push provisioning (Apple Pay, Google Pay) in your own mobile app."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens","summary":"List payment tokens for a card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/digital-wallet/pushprovisioningpaymenttokenslist","deprecated":false},{"title":"/spend/profiles/{profileId}/cards/{cardToken}/payment-tokens/{paymentTokenUniqueReference}/activation","summary":"Manual provisioning payment token activation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/digital-wallet/digitalwalletactivatepaymenttoken","deprecated":false},{"title":"/twcard-data/v1/push-provisioning/encrypted-payload/google-pay","summary":"Push provisioning for Google Pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/digital-wallet/pushprovisioninggooglepayget","deprecated":false},{"title":"/twcard-data/v1/push-provisioning/encrypted-payload/apple-pay","summary":"Push Provisioning for Apple Pay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/digital-wallet/pushprovisioningapplepayget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeDynamicFlowStep","name":"Dispute dynamic flow entry point","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispute dynamic flow entry point","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the JSON for initiating the dispute flow. Use this endpoint with Wise's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.npmjs.com/package/@transferwise/dynamic-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Flow framework"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON response must be passed into the Dynamic Flow framework, which handles the multi-step dispute submission including the generation of subsequent pages and the creation of the dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting up the API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will need to implement a GET API with the following format:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET https://{{yourApiUrl}}/v3/spend/profiles/{{profileId}}/dispute-form/flows/step/{{scheme}}/{{reason}}?transactionId={{transactionId}}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API should forward the call to:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST https://{{wiseUrl}}/v3/spend/profiles/{{profileId}}/dispute-form/flows/step/{{scheme}}/{{reason}}?transactionId={{transactionId}}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required as the dynamic flow returned by Wise will automatically be configured to call your GET API. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fetcher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as part of the dynamic flow setup to redirect the Dynamic Flow JavaScript library to your domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a full integration guide, including example backend implementation and styling, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-dynamic-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disputes via Dynamic Flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":14547572},{"name":"scheme","in":"path","schemaId":"schema_813","description":"The network of the card that was used to make this transaction.","required":true,"example":"VISA"},{"name":"reason","in":"path","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute reason code supplied by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes/disputereasonsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute reasons endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"TROUBLE_WITH_GOODS_SERVICES"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"transactionId","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the transaction being disputed. Can be a comma-separated list of IDs if the reason code has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supportsMultipleTransactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag."},"children":[]}]}]}],"required":true,"example":"6789"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_814","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":14547572,"schemaId":"schema_650"},{"name":"scheme","in":"path","required":true,"example":"VISA","schemaId":"schema_813"},{"name":"reason","in":"path","required":true,"example":"TROUBLE_WITH_GOODS_SERVICES","schemaId":"schema_639"}],"query":[{"name":"transactionId","in":"query","required":true,"example":"6789","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_814","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}","href":"disputes/disputedynamicflowstep","openApiOperationId":"disputeDynamicFlowStep","summary":"Dispute dynamic flow entry point"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_814","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns information required to populate the form with the correct information. Note how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the URL and method to the next step."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_815","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_815","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputedynamicflowstep"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeReasonsGet","name":"Retrieve dispute reasons","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve dispute reasons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the list of possible reasons for submitting a dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a reason code has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", those should be used as the reason code when submitting disputes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":14547572}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/dispute-form/reasons","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":14547572,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/dispute-form/reasons","href":"disputes/disputereasonsget","openApiOperationId":"disputeReasonsGet","summary":"Retrieve dispute reasons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of dispute reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_816","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_816","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_816","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_816","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputereasonsget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/dispute-form/reasons"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeSubmit","name":"Submit dispute","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a dispute for a card transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body structure varies per dispute reason code. All reasons share a common structure with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disclaimer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects, but the fields within "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" differ per reason."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For per-reason request body details, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-api#reason-examples"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disputes via API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":14547572},{"name":"scheme","in":"path","schemaId":"schema_813","description":"The network of the card that was used to make this transaction.","required":true,"example":"VISA"},{"name":"reason","in":"path","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute reason code supplied by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes/disputereasonsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute reasons endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"WRONG_AMOUNT"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_817","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_817","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":14547572,"schemaId":"schema_650"},{"name":"scheme","in":"path","required":true,"example":"VISA","schemaId":"schema_813"},{"name":"reason","in":"path","required":true,"example":"WRONG_AMOUNT","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_817","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}","href":"disputes/disputesubmit","openApiOperationId":"disputeSubmit","summary":"Submit dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_817","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_817","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dynamic Flow JSON response. If using the Dynamic Flow framework, pass this to the framework. If using the API directly, the response can be ignored.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_818","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_818","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_818","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_818","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputesubmit"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeFileUpload","name":"Upload dispute file","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload dispute file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a file for use in a dispute submission. Use the returned file ID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"files"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object when submitting a dispute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A dispute referencing the returned file ID must be submitted no later than "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two hours"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after the file upload, otherwise the file will expire and must be re-uploaded."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":14547572}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_819"}},"schemaId":"schema_819","pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/spend/profiles/{profileId}/dispute-form/file","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":14547572,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_819"}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/dispute-form/file","href":"disputes/disputefileupload","openApiOperationId":"disputeFileUpload","summary":"Upload dispute file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_819","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_819"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A key-value pair mapping the file name to the assigned file ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_820","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_820","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_820","exampleIds":["paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputefileupload"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/dispute-form/file"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeList","name":"List disputes","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List disputes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List disputes for a profile with optional filters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":16605997}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_821","description":"Filter by dispute status.","example":"ACTIVE"},{"name":"transactionId","in":"query","schemaId":"schema_650","description":"Filter by card transaction ID.","example":2040},{"name":"pageSize","in":"query","schemaId":"schema_822","description":"The maximum number of disputes to return per page. Between 10 and 100, defaults to 10.","example":10},{"name":"pageNumber","in":"query","schemaId":"schema_823","description":"The page number to retrieve. Must be at least 1, defaults to 1.","example":1}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/disputes","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":16605997,"schemaId":"schema_650"}],"query":[{"name":"status","in":"query","required":false,"example":"ACTIVE","schemaId":"schema_821"},{"name":"transactionId","in":"query","required":false,"example":2040,"schemaId":"schema_650"},{"name":"pageSize","in":"query","required":false,"example":10,"schemaId":"schema_822"},{"name":"pageNumber","in":"query","required":false,"example":1,"schemaId":"schema_823"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/disputes","href":"disputes/disputelist","openApiOperationId":"disputeList","summary":"List disputes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of disputes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_824","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_824","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_824","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_824","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputelist"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/disputes"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeGet","name":"Get dispute","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a dispute by its ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":16605997},{"name":"disputeId","in":"path","schemaId":"schema_639","description":"The dispute ID.","required":true,"example":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spend/profiles/{profileId}/disputes/{disputeId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":16605997,"schemaId":"schema_650"},{"name":"disputeId","in":"path","required":true,"example":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/disputes/{disputeId}","href":"disputes/disputeget","openApiOperationId":"disputeGet","summary":"Get dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The dispute.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}},"schemaId":"components/schemas/Dispute","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputeget"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/disputes/{disputeId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disputeWithdraw","name":"Withdraw dispute","isWebhook":false,"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Withdraw dispute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdraw a dispute by setting its status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only withdraw a dispute if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canWithdraw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the dispute resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":16605997},{"name":"disputeId","in":"path","schemaId":"schema_639","description":"The dispute ID.","required":true,"example":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_825","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_825","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/spend/profiles/{profileId}/disputes/{disputeId}/status","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":16605997,"schemaId":"schema_650"},{"name":"disputeId","in":"path","required":true,"example":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb","schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_825","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/spend/profiles/{profileId}/disputes/{disputeId}/status","href":"disputes/disputewithdraw","openApiOperationId":"disputeWithdraw","summary":"Withdraw dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_825","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_825","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated dispute.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Dispute","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Dispute","exampleIds":["paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/disputewithdraw"}],"panels":[]}]},"httpPath":"/spend/profiles/{profileId}/disputes/{disputeId}/status"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransactionDisputesUpdate","name":"Transaction disputes update","isWebhook":true,"pointer":"/paths/transaction-disputes#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction disputes update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transaction dispute is submitted or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may receive update events even when there are no apparent changes in the dispute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as certain underlying modifications might not directly impact these visible indicators."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction-disputes#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transaction-disputes#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"schemaId":"schema_826","pointer":"/paths/transaction-disputes#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-disputes#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_826"}},"responseCodes":["200"],"pointer":"transaction-disputes#update","href":"disputes/eventtransactiondisputesupdate","openApiOperationId":"eventTransactionDisputesUpdate","summary":"Transaction disputes update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_826","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transaction-disputes#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/eventtransactiondisputesupdate"}],"panels":[]}]},"httpPath":"transaction-disputes#update"}],"content":{"contentType":"group","meta":{"name":"disputes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disputes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raise and manage card transaction disputes, including submission via Dynamic Flow or direct API, file uploads, and dispute lifecycle tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For implementation details, see:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-dynamic-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disputes via Dynamic Flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — build a dispute UI using the Dynamic Flow framework"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disputes via API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — submit disputes directly, with per-reason request body details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — track and withdraw disputes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"dispute-sub-status","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute sub-statuses "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMITTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Initial status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The dispute is under review or requires additional information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUNDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The refund has been processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The dispute is invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITHDRAWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The customer has withdrawn the dispute"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFIRMED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The dispute has been reviewed but a refund is not applicable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND_IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A refund is being processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATTEMPTING_RECOVERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A chargeback request has been submitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECOVERY_UNSUCCESSFUL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The chargeback attempt was unsuccessful"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status transition diagram may undergo modifications in the future and only covers regular pathways."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/dispute-status-flow.57ccace5654bb12a05bbf947810e94d32436de58dad595021ec80514c862ff06.28b10c14.png","alt":"Dispute statuses transition diagram"},"children":[]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/spend/profiles/{profileId}/dispute-form/flows/step/{scheme}/{reason}","summary":"Dispute dynamic flow entry point","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/disputedynamicflowstep","deprecated":false},{"title":"/spend/profiles/{profileId}/dispute-form/reasons","summary":"Retrieve dispute reasons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/disputereasonsget","deprecated":false},{"title":"/spend/profiles/{profileId}/dispute-form/flows/{scheme}/{reason}","summary":"Submit dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/disputesubmit","deprecated":false},{"title":"/spend/profiles/{profileId}/dispute-form/file","summary":"Upload dispute file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/disputefileupload","deprecated":false},{"title":"/spend/profiles/{profileId}/disputes","summary":"List disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/disputelist","deprecated":false},{"title":"/spend/profiles/{profileId}/disputes/{disputeId}","summary":"Get dispute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/disputeget","deprecated":false},{"title":"/spend/profiles/{profileId}/disputes/{disputeId}/status","summary":"Withdraw dispute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/disputes/disputewithdraw","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"transaction-disputes#update","summary":"Transaction disputes update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/eventtransactiondisputesupdate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Quotes","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"quote"},"seo":{"title":"Quote"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/quote"},"children":[]}]}]}},{"type":"link","label":"Types of quotes","link":"/api-reference/quote/types-of-quotes","routeSlug":"/api-reference/quote/types-of-quotes","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Types of quotes"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quote/types-of-quotes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of quotes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the Wise API you can create either "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unauthenticated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quotes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated quotes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are for illustrative purposes only. Use this option to display example rates before a user has created or linked an account. This endpoint does not required an auth token and the response has no ID, so it cannot be used to create a transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticated quotes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" require an auth token and provide a quote ID in the response, which you then use when creating a transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon creating an authenticated quote, the current mid-market exchange rate is locked and will be used for the transfer created from the quote. The rate is locked for 30 minutes to give a user time to submit the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quote response contains details like the exchange rate, the estimated delivery time, applicable fees, methods for the user to pay for the transfer, and quote expiration time. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all fields are applicable to all use cases"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quoteCreateUnauthenticated","name":"Create a quote (unauthenticated)","isWebhook":false,"pointer":"/paths/~1quotes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a quote (unauthenticated)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 and can't be used to create a transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get quotes with an accurate partner fee, include the Authorization header in the request with your client credentials token. Otherwise, you do not need to include the Authorization header."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthenticated quotes cannot be used to create transfers. They are meant for illustration purposes in partner interfaces only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a transfer, be sure to use an authenticated quote."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1quotes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_827"}},"schemaId":"schema_827","pointer":"/paths/~1quotes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_827"}},"responseCodes":["200","429"],"pointer":"/quotes","href":"quote/quotecreateunauthenticated","openApiOperationId":"quoteCreateUnauthenticated","summary":"Create a quote (unauthenticated)","securityGroups":[{"ClientCredentialsToken":[]},{}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_827","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_827"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a quote object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1quotes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/quotecreateunauthenticated"}],"panels":[]}]},"httpPath":"/quotes"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quoteCreate","name":"Create a quote (authenticated)","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1quotes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a quote (authenticated)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an authenticated quote when the quote is to be used for a transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticated quotes require a user access token to authenticate. You must also include the profile the quote should be associated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are funding the transfer from a multi-currency balance, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise this field defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", causing the fees to be inconsistent between quote and transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT_OUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it enables payment protection for SWIFT recipients of global currency transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, you can guarantee to your customers that the fee will be charged to the sender, ensuring the recipient receives the full target amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quote/quotecreate/request/paymentoptions-in-the-response","deepLinkHash":"/quote/quotecreate#quote/quotecreate/request/paymentoptions-in-the-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentOptions in the response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A few things to note about the data in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used to select the correct entry in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array so you know which fees to display to your customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field shown at the top level of the quote resource and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the settlement model the bank is using. By default, this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless you are using a prefunded or bulk settlement model."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field changes based on the type of recipient you add to the quote in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update quote request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, to-USD "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or to-CAD "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interac"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have different fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which gives a full breakdown of all the taxes, fees, and discounts. Refer to this structure for breakdowns and totals, rather than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure as that only gives a summary and does not surface important specifics such as taxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When showing the price of a transfer always show the 'price.total.value.amount' of a payment option."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each payment option is either enabled or disabled based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disabled payment options should be shown to the user in a disabled state in most cases. This ensures users are given the options they are familiar with regardless of their availability, as well as options that can be beneficial to their accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"option.disabledReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains both a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The message is the user-friendly text to surface to the user, if necessary."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quote/quotecreate/request/transfer-nature-for-brl","deepLinkHash":"/quote/quotecreate#quote/quotecreate/request/transfer-nature-for-brl"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer nature for BRL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferNature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for transfers to or from BRL. It also impacts the fees charged on the quote, specifically the IOF."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IOF is determined based on the transfer nature, sender information, and recipient information. The default IOF is included in a quote until all relevant information has been included."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferNature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not prevent the transfer from being created or even funded. However, when attempting to process the transfer, it will be blocked and the money will be refunded to the sender."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quote/quotecreate/request/pricing-configuration","deepLinkHash":"/quote/quotecreate#quote/quotecreate/request/pricing-configuration"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating or updating a quote, partners with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/quotes/pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flexible partner pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled can override the pricing configuration dynamically."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Personal or business profile ID of the sender.","required":true,"example":101}],"pointer":"/paths/~1profiles~1{profileId}~1quotes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_828"}},"schemaId":"schema_828","pointer":"/paths/~1profiles~1{profileId}~1quotes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/quotes","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":101,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_828"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/quotes","href":"quote/quotecreate","openApiOperationId":"quoteCreate","summary":"Create a quote (authenticated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_828","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_828"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a quote object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/quotecreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/quotes"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quoteGet","name":"Retrieve a quote by ID","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a quote by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get quote info by ID. If the quote has expired (not used to create a transfer within 30 minutes of quote creation), it will only be accessible for approximately 48 hours via this endpoint.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Personal or business profile ID.","required":true,"example":101},{"name":"quoteId","in":"path","schemaId":"schema_647","description":"The quote ID (GUID format).","required":true,"example":"11144c35-9fe8-4c32-b7fd-d05c2a7734bf"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/quotes/{quoteId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":101,"schemaId":"schema_650"},{"name":"quoteId","in":"path","required":true,"example":"11144c35-9fe8-4c32-b7fd-d05c2a7734bf","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/quotes/{quoteId}","href":"quote/quoteget","openApiOperationId":"quoteGet","summary":"Retrieve a quote by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a quote object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/quoteget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/quotes/{quoteId}"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quoteUpdate","name":"Update a quote","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When generating a quote before a recipient, you must update the quote with the recipient "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, as the recipient details may impact the quote properties like available payment options, price, and estimated delivery time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When updating a quote, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field may change to denote the payment option you should select when sending to the recipient. For example, sending USD to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" recipient or CAD to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interac"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" recipient changes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERAC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" respectively. This field defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it can be used in all cases to help select the correct "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentOption"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and hence show the correct pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If pricing changes after updating a quote for a recipient, be sure to inform your customer before confirming the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To provide more transparency for fees charged for SWIFT recipients, consider setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT_OUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This ensures the recipient receives the full target amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quote/quoteupdate/request/transfer-nature-for-brl","deepLinkHash":"/quote/quoteupdate#quote/quoteupdate/request/transfer-nature-for-brl"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Nature for BRL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferNature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for transfers to or from BRL. It also impacts the fees charged on the quote, specifically the IOF."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IOF is determined based on the transfer nature, sender information, and recipient information. The default IOF is included in a quote until all relevant information has been included."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferNature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not prevent the transfer from being created or even funded. However, when attempting to process the transfer, it will be blocked and the money will be refunded to the sender."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Personal or business profile ID.","required":true,"example":101},{"name":"quoteId","in":"path","schemaId":"schema_647","description":"The quote ID (GUID format).","required":true,"example":"11144c35-9fe8-4c32-b7fd-d05c2a7734bf"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"schema_829"}},"schemaId":"schema_829","pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/profiles/{profileId}/quotes/{quoteId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":101,"schemaId":"schema_650"},{"name":"quoteId","in":"path","required":true,"example":"11144c35-9fe8-4c32-b7fd-d05c2a7734bf","schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/merge-patch+json":{"schemaId":"schema_829"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/quotes/{quoteId}","href":"quote/quoteupdate","openApiOperationId":"quoteUpdate","summary":"Update a quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_829","mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"schema_829"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a quote object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}},"schemaId":"components/schemas/quote","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1quotes~1{quoteId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/quote"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/quoteupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/quotes/{quoteId}"}],"content":{"contentType":"group","meta":{"name":"quote"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quote resource defines the currencies involved in a transfer, the amount to send, and the profile sending the money."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quote resource is one of the resources required when creating a transfer, along with the recipient account that is receiving the funds."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Quote","link":"/quote/quote","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/quotes","summary":"Create a quote (unauthenticated)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quote/quotecreateunauthenticated","deprecated":false},{"title":"/profiles/{profileId}/quotes","summary":"Create a quote (authenticated)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quote/quotecreate","deprecated":false},{"title":"/profiles/{profileId}/quotes/{quoteId}","summary":"Retrieve a quote by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote/quoteget","deprecated":false},{"title":"/profiles/{profileId}/quotes/{quoteId}","summary":"Update a quote","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/quote/quoteupdate","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rateGet","name":"Retrieve current rates","isWebhook":false,"pointer":"/paths/~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve current rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters are not testable in our Sandbox environment at this time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch latest exchange rates of all currencies."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates?source=EUR&target=USD"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch latest exchange rate of one currency pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates?source=EUR&target=USD&time=2019-02-13T14:53:01"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch exchange rate of specific historical timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates?source=EUR&target=USD&from=2019-02-13T14:53:01&to=2019-03-13T14:53:01&group=day"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch exchange rate history over period of time with daily interval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates?source=EUR&target=USD&from=2019-02-13T14:53:01&to=2019-03-13T14:53:01&group=hour"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch exchange rate history over period of time with hourly interval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /rates?source=EUR&target=USD&from=2019-02-13T14:53:01&to=2019-03-13T14:53:01&group=minute"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch exchange rate history over period of time with 1 minute interval."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint only supports Bearer authentication for non-Affiliate partners."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source","in":"query","schemaId":"schema_639","description":"Source (send) currency code.","example":"EUR"},{"name":"target","in":"query","schemaId":"schema_639","description":"Target (receive) currency code.","example":"USD"},{"name":"time","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp to get historic exchange rate. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports only Timestamp (combined date and time). Timezone offset is supported but optional. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13T14:53:01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13T14:53:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2019-02-13T14:53:01"},{"name":"from","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period start date/time to get exchange rate history. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Timestamp (combined date and time) or Date (date only). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13T14:53:01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2019-02-13T14:53:01"},{"name":"to","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period end date/time to get exchange rate history. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports Timestamp (combined date and time) or Date (date only). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone offset is supported but optional. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13T14:53:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2019-03-13+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2019-03-13T14:53:01"},{"name":"group","in":"query","schemaId":"schema_830","description":"Interval for history grouping.","example":"day"}],"pointer":"/paths/~1rates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rates","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"source","in":"query","required":false,"example":"EUR","schemaId":"schema_639"},{"name":"target","in":"query","required":false,"example":"USD","schemaId":"schema_639"},{"name":"time","in":"query","required":false,"example":"2019-02-13T14:53:01","schemaId":"schema_639"},{"name":"from","in":"query","required":false,"example":"2019-02-13T14:53:01","schemaId":"schema_639"},{"name":"to","in":"query","required":false,"example":"2019-03-13T14:53:01","schemaId":"schema_639"},{"name":"group","in":"query","required":false,"example":"day","schemaId":"schema_830"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","429"],"pointer":"/rates","href":"rate/rateget","openApiOperationId":"rateGet","summary":"Retrieve current rates","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of exchange rate values which meet your query criteria.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_831"}},"schemaId":"schema_831","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1rates/get/responses/400/content/application~1json/examples/badRequest"]}},"exampleIds":["paths/~1rates/get/responses/400/content/application~1json/examples/badRequest"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_831","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_831"}}},{"code":"400","exampleIds":["paths/~1rates/get/responses/400/content/application~1json/examples/badRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1rates/get/responses/400/content/application~1json/examples/badRequest"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rate/rateget"}],"panels":[]}]},"httpPath":"/rates"}],"content":{"contentType":"group","meta":{"name":"rate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange Rates","showPageActions":true},{"nodeType":"markdoc","content":"Current and historical exchange rates by currency routes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rates","summary":"Retrieve current rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rate/rateget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"comparisonGet","name":"Request a comparison quote","isWebhook":false,"pointer":"/paths/~1comparisons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request a comparison quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request price and speed comparison data for money transfer providers on a given currency route."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipientGetsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (but not both)."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sourceCurrency","in":"query","schemaId":"schema_639","description":"ISO 4217 source currency code","required":true,"example":"GBP"},{"name":"targetCurrency","in":"query","schemaId":"schema_639","description":"ISO 4217 target currency code","required":true,"example":"EUR"},{"name":"sendAmount","in":"query","schemaId":"schema_832","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to send in source currency. Must provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipientGetsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":10000},{"name":"recipientGetsAmount","in":"query","schemaId":"schema_832","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be received in target currency. Must provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipientGetsAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"midMarketRate","in":"query","schemaId":"schema_832","description":"Current mid-market rate between the source and target currency"},{"name":"wiseFee","in":"query","schemaId":"schema_832","description":"Wise's fee, if the Wise quote is known"},{"name":"wiseEstimatedDelivery","in":"query","schemaId":"schema_639","description":"Wise's estimated delivery timestamp, if the Wise quote is known"},{"name":"wiseQuoteCreatedTime","in":"query","schemaId":"schema_639","description":"Timestamp when the Wise quote was created"},{"name":"payInMethod","in":"query","schemaId":"schema_639","description":"Change the pay-in method of the Wise quote only (all other quotes will remain as bank transfer)"},{"name":"sourceCountry","in":"query","schemaId":"schema_639","description":"Filter by source country (ISO 3166-1 Alpha-2 code)"},{"name":"targetCountry","in":"query","schemaId":"schema_639","description":"Filter by target country (ISO 3166-1 Alpha-2 code)"},{"name":"providerCountry","in":"query","schemaId":"schema_639","description":"Filter by provider country (ISO 3166-1 Alpha-2 code)"},{"name":"filter","in":"query","schemaId":"schema_833","description":"Filter by most popular competitors"},{"name":"numberOfProviders","in":"query","schemaId":"schema_628","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of popular competitors to return if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POPULAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - default value is 4"},"children":[]}]}]}]},{"name":"providerTypes","in":"query","schemaId":"schema_834","description":"Filter by provider type"},{"name":"providers","in":"query","schemaId":"schema_639","description":"Filter by specific provider aliases"},{"name":"excludePartners","in":"query","schemaId":"schema_657","description":"Exclude Wise's partner banks - default true"},{"name":"includeWise","in":"query","schemaId":"schema_657","description":"Overrides filters to ensure Wise data is returned, even if exclusionary filters are applied"}],"pointer":"/paths/~1comparisons/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1comparisons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/comparisons","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"sourceCurrency","in":"query","required":true,"example":"GBP","schemaId":"schema_639"},{"name":"targetCurrency","in":"query","required":true,"example":"EUR","schemaId":"schema_639"},{"name":"sendAmount","in":"query","required":false,"example":10000,"schemaId":"schema_832"},{"name":"recipientGetsAmount","in":"query","required":false,"schemaId":"schema_832"},{"name":"midMarketRate","in":"query","required":false,"schemaId":"schema_832"},{"name":"wiseFee","in":"query","required":false,"schemaId":"schema_832"},{"name":"wiseEstimatedDelivery","in":"query","required":false,"schemaId":"schema_639"},{"name":"wiseQuoteCreatedTime","in":"query","required":false,"schemaId":"schema_639"},{"name":"payInMethod","in":"query","required":false,"schemaId":"schema_639"},{"name":"sourceCountry","in":"query","required":false,"schemaId":"schema_639"},{"name":"targetCountry","in":"query","required":false,"schemaId":"schema_639"},{"name":"providerCountry","in":"query","required":false,"schemaId":"schema_639"},{"name":"filter","in":"query","required":false,"schemaId":"schema_833"},{"name":"numberOfProviders","in":"query","required":false,"schemaId":"schema_628"},{"name":"providerTypes","in":"query","required":false,"schemaId":"schema_834"},{"name":"providers","in":"query","required":false,"schemaId":"schema_639"},{"name":"excludePartners","in":"query","required":false,"schemaId":"schema_657"},{"name":"includeWise","in":"query","required":false,"schemaId":"schema_657"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[],"responseCodes":["200","429"],"pointer":"/comparisons","href":"comparison/comparisonget","openApiOperationId":"comparisonGet","summary":"Request a comparison quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Comparison data retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Comparison","exampleIds":["paths/~1comparisons/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Comparison","exampleIds":["paths/~1comparisons/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1comparisons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Comparison","exampleIds":["paths/~1comparisons/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Comparison","exampleIds":["paths/~1comparisons/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/comparison/comparisonget"}],"panels":[]}]},"httpPath":"/comparisons"}],"content":{"contentType":"group","meta":{"name":"comparison"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comparison","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The comparison API can be used to request price and speed information about various money transfer providers. This includes not only Wise but other providers in the market."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"comparison-price-estimation","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price Estimation "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quotes (price and speed) provided by this API are based off of real quotes collected from 3rd party websites. We collect both the advertised exchange rate and fee for each provider for various amounts. When a comparison is requested, we calculate the markup percentage of the collected exchange rate on the mid-market rate at the time of collection. We then apply this markup to the current mid-market rate to provide a realistic estimate of what each provider offers. We collect data for all providers around once per hour to ensure we provide as accurate and up-to-date information as possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Today, we only provide estimations for FX transactions with a Bank Transfer pay-in and pay-out option. This is important to stress as many providers offer significantly different fees and exchange rates when used debit/credit card, cash etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details on the data collection process please see the following page:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/gb/compare/disclaimer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://wise.com/gb/compare/disclaimer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have questions or suspect any data to be inaccurate or incomplete please contact us at: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:comparison@wise.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comparison@wise.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"comparison-delivery-estimation","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Estimation "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similar to price, we collect speed data for most (if not all) providers which we have price information for. Many providers display speed estimates to their customers in a number of different ways."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The transfer should be complete within 2-5 days\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"The money should arrive in your account within 48 hours\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Should arrive by 26th Aug\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Could take up to 4 working days\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The below API intends to model these in a consistent format by providing a minimum and maximum range for all delivery estimations. An estimate that states \"up to X\" will have \"max\" set to a duration but \"min\" as null; \"from X\" will have \"min\" set to a duration and \"max\" as null. Finally, for those providers who offer a specific, point in time estimation (like Wise), the API will surface a duration where \"min\" and \"max\" are equal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"id":"comparison-quotes-structure","class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quotes structure "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to provide the most flexible and accurate data for clients, we surface a denormalized list of quotes per provider where each quote represents a unique collection of comparison \"dimensions\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single given provider may expose multiple quotes for the same currency route. The most common example is where a provider offers different pricing for two different countries which use the same currency, e.g.:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider X:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP EUR 1000 [GB -> ES] fee: 10, rate: 1.5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP EUR 1000 [GB -> DE] fee: 8, rate: 1.5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP EUR 1000 [GB -> FR] fee: 10, rate: 1.35"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same principle applies for speed, i.e. a provider may have different speed estimates for different target countries. Hence, we expose these as discrete quotes, where a quote is a unique combination of route, country, speed and price factors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A client may choose to reduce this set of quotes down to a single or several quotes in order to display a relevant quote to a given user. An example where we take the cheapest quote for a given currency route (and also surface the target country) can be seen at the below link:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/gb/compare/?sourceCurrency=GBP&targetCurrency=EUR&sendAmount=1000"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://wise.com/gb/compare/?sourceCurrency=GBP&targetCurrency=EUR&sendAmount=1000"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/comparisons","summary":"Request a comparison quote","prefix":{"name":"get","color":"get"},"badges":[],"link":"/comparison/comparisonget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Recipients","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"recipient"},"seo":{"title":"Recipient Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient Account","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/recipient"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientList","name":"List recipient accounts","isWebhook":false,"pointer":"/paths/~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List recipient accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches a list of the user's recipient accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientlist/request/notes-about-query-params","deepLinkHash":"/recipient/recipientlist#recipient/recipientlist/request/notes-about-query-params"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes about query params"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All query parameters are optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to determine the number of accounts per page (max 20)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seekPosition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to the value returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seekPositionForNext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the previous response to retrieve the next page."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creatorId","in":"query","schemaId":"schema_650","description":"Creator of the account."},{"name":"profileId","in":"query","schemaId":"schema_650","description":"Filters by the personal or business profile that created the account. Defaults to the personal profile."},{"name":"profile","in":"query","schemaId":"schema_650","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the response by target currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for presenting a list of recipients to your customer when they have already indicated the target currency in your flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports comma-separated values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD,GBP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"active","in":"query","schemaId":"schema_835","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by whether the selected profile is active. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters the response by account type. Supports comma-separated values (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban,swift_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"ownedByCustomer","in":"query","schemaId":"schema_657","description":"Filters the response by whether the account is owned by the customer. Leave out to retrieve all accounts."},{"name":"size","in":"query","schemaId":"schema_836","description":"The number of accounts returned in a page of the response. Defaults to 20 (the maximum)."},{"name":"seekPosition","in":"query","schemaId":"schema_837","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For pagination, use the value from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seekPositionForNext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the previous response to retrieve the next page."},"children":[]}]}]}]},{"name":"sort","in":"query","schemaId":"schema_838","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the sorting strategy for the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses comma-separated options (either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first, followed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for direction)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?sort=id,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts in ascending order by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?sort=id,desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts in descending order by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?sort=currency,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts in ascending order by currency."},"children":[]}]}]}]}]}],"pointer":"/paths/~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"creatorId","in":"query","required":false,"schemaId":"schema_650"},{"name":"profileId","in":"query","required":false,"schemaId":"schema_650"},{"name":"profile","in":"query","required":false,"schemaId":"schema_650"},{"name":"currency","in":"query","required":false,"schemaId":"schema_639"},{"name":"active","in":"query","required":false,"schemaId":"schema_835"},{"name":"type","in":"query","required":false,"schemaId":"schema_639"},{"name":"ownedByCustomer","in":"query","required":false,"schemaId":"schema_657"},{"name":"size","in":"query","required":false,"schemaId":"schema_836"},{"name":"seekPosition","in":"query","required":false,"schemaId":"schema_837"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_838"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","429"],"pointer":"/accounts","href":"recipient/recipientlist","openApiOperationId":"recipientList","summary":"List recipient accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of recipient accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_839","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_839","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Unauthorized.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_839","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_839","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"401"},{"code":"403"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientlist"}],"panels":[]}]},"httpPath":"/accounts"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientCreate","name":"Create a recipient account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a recipient account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a recipient account. A "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the person or institution who is the ultimate beneficiary of your payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient data includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The personal details of an individual or basic information about a business."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank details like account numbers, routing numbers, and other region-specific information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address details like country and street address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certain fields shown in the schema are conditionally required depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference uses a GBP example for illustration purposes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As such, some fields are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the provided examples. To determine which fields are required for a currency corridor, use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientaccountrequirementsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve recipient account requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientcreate/request/bank-account-details","deepLinkHash":"/recipient/recipientcreate#recipient/recipientcreate/request/bank-account-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are many variations of required bank account details, depending on recipient target currency. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GBP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires sort code and account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BGN, CHF, DKK, EUR, GEL, GBP, NOK, PKR, PLN, RON, SEK"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" require IBAN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires routing number, account number, and account type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INR"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires IFSC code and account number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientcreate/request/address-details","deepLinkHash":"/recipient/recipientcreate#recipient/recipientcreate/request/address-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient address data is required only if target currency is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD, PHP, THB or TRY"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or if the source currency is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD or AUD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address fields can include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State (required for US, Canada, Brazil)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address line"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zip code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientcreate/request/accountholdername-rules","deepLinkHash":"/recipient/recipientcreate#recipient/recipientcreate/request/accountholdername-rules"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accountHolderName rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal recipients"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Full names must include more than one name, and both first and last name must have more than one character. Numbers are not allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business recipients"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Business names must be in full and can be a single name. The full name cannot be just a single character, but can be made up of a set of single characters (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"A\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not permitted but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"A 1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"A1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is permitted)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_()'*,."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are allowed for personal and business names. In general, the following regex describes permitted characters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[0-9A-Za-zÀ-ÖØ-öø-ÿ-_()'*,.\\s]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientcreate/request/creating-a-refund-recipient-account","deepLinkHash":"/recipient/recipientcreate#recipient/recipientcreate/request/creating-a-refund-recipient-account"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a refund recipient account"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sometimes we may need to refund the transfer back to the sender. The "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund recipient"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the person or institution who we refund the transfer money back to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not always mandatory to create a refund recipient."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the funds are sent over a fast local payment network, we can usually infer the refund recipient from the bank transaction that funded the transfer. Please discuss this with your Wise implementation team if you are unsure if the refund recipient is needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If funds are sent using a slow domestic payment network, or you are using a bulk settlement model, we may require you to share the bank details of the source bank account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate a recipient account is a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund recipient"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include the query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then, use the account ID returned in the response as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientcreate/request/creating-an-email-recipient-account","deepLinkHash":"/recipient/recipientcreate#recipient/recipientcreate/request/creating-an-email-recipient-account"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating an email recipient account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact us before attempting to use email recipients as it is only recommended for certain use cases."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't know recipient bank account details, you can set up an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email recipient"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Wise then collects bank details directly from the recipient."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise will email your recipient with a link to collect their bank account details securely. After the bank account details have been provided, Wise completes the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm this recipient type is available for your transaction by checking if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"type\": \"email\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" class is present in the response of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientaccountrequirementsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve recipient account requirements endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If planning to send multiple currencies to a single recipient, you must create a separate email recipient resource for the beneficiary, for every currency you intend to send them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be aware of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing of transfers to email recipients in sandbox is not currently possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipients are required to enter bank details "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every time a payment is made"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We highly encourage you to provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if your recipient is receiving a payment from your business account, especially if you have multiple businesses or have multiple users administrating your business account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to our "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2932105/can-i-send-money-to-someone-with-only-their-email-address"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"help page"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details about how this works and any additional constraints not mentioned here."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"refund","in":"query","schemaId":"schema_840","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the request creates a refund recipient account."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/recipient-create-request","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient","paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"]}},"schemaId":"components/schemas/recipient-create-request","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient","paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"],"pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"refund","in":"query","required":false,"schemaId":"schema_840"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/recipient-create-request","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient","paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"]}},"responseCodes":["200","400","401","429"],"pointer":"/accounts","href":"recipient/recipientcreate","openApiOperationId":"recipientCreate","summary":"Create a recipient account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/recipient-create-request","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient","paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/recipient-create-request","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient","paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipient account created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}},"schemaId":"components/schemas/recipient","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — validation error."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_841"}},"schemaId":"schema_841","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse"]}},"exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/recipient","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}}},{"code":"400","schemaId":"schema_841","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_841"}}},{"code":"401","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientcreate"}],"panels":[]}]},"httpPath":"/accounts"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientGet","name":"Get account by ID","isWebhook":false,"pointer":"/paths/~1accounts~1{accountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get recipient account info by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V1 and v2 versions are cross compatible, but the v2 endpoint provides additional features."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_650","description":"Recipient account ID.","required":true}],"pointer":"/paths/~1accounts~1{accountId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts~1{accountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{accountId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/accounts/{accountId}","href":"recipient/recipientget","openApiOperationId":"recipientGet","summary":"Get account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipient account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}},"schemaId":"components/schemas/recipient","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts~1{accountId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/recipient","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientget"}],"panels":[]}]},"httpPath":"/accounts/{accountId}"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientDeactivate","name":"Deactivate a recipient account","isWebhook":false,"pointer":"/paths/~1accounts~1{accountId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a recipient account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a recipient by changing its status to inactive ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"active\": false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request to delete a recipient that is already inactive returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTTP 403 (Forbidden)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only active recipients can be deleted. While a recipient cannot be reactivated, you can create a new recipient with the same details if necessary."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_650","description":"Recipient account ID.","required":true}],"pointer":"/paths/~1accounts~1{accountId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts~1{accountId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accounts/{accountId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/accounts/{accountId}","href":"recipient/recipientdeactivate","openApiOperationId":"recipientDeactivate","summary":"Deactivate a recipient account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}},"schemaId":"components/schemas/recipient","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts~1{accountId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/recipient","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientdeactivate"}],"panels":[]}]},"httpPath":"/accounts/{accountId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientAccountRequirementsGet","name":"Retrieve recipient account requirements dynamically","isWebhook":false,"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve recipient account requirements dynamically","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can then choose to use Wise’s dynamic forms to gather the required data from your customer, hard-code the requirements into your system, or use a combination of both hard-coded and dynamic forms."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refreshRequirementsOnChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for any item in the response’s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, this indicates additional field requirements that are conditional to the specific data "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field becomes required. To retrieve additional requirements, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientaccountrequirementspost"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to requery and retrieve the updated requirements. For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.country = \"US\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" example, the response returns a list of valid state names."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientaccountrequirementsget/request/operation-variants","deepLinkHash":"/recipient/recipientaccountrequirementsget#recipient/recipientaccountrequirementsget/request/operation-variants"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation variants"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can query this endpoint either "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a quote ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With quote ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /quotes/{quoteId}/account-requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended when using the quote-first transfer flow. The response returns the requirements for the currency corridor specified in that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote/quotecreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticated quote resource"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without quote ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /account-requirements?source=EUR&target=USD&sourceAmount=1000"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this variation if you do not have a quote ID (as in recipient-first transfer flows). In this request, you specify the source currency, target currency, and source amount as query parameters and the response returns the relevant requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Recipient-first limitations"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The variation without a quote ID is not valid for some currencies, as some payout methods only surface when profile-context is known. For example, at the time of this writing, business payments to Chinese Yuan use a different payout method than what is revealed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /account-requirements?source=USD&target=CNY&sourceAmount=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm with your implementation team if certain corridors should not use the recipient-first transfer flow."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"recipient/recipientaccountrequirementsget/request/accept-minor-versions-header","deepLinkHash":"/recipient/recipientaccountrequirementsget#recipient/recipientaccountrequirementsget/request/accept-minor-versions-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept minor versions header"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All new integrations should use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Minor-Version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the value set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This ensures the response includes both the recipient name and email fields, which are required to support currencies such as KRW, JPY and RUB. It also removes the need for manual name validation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quoteId","in":"path","schemaId":"schema_639","description":"Quote ID (supports long or UUID-based IDs).","required":true}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"originatorLegalEntityType","in":"query","schemaId":"schema_842","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal entity type override for the actual sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correspondent partners must include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originatorLegalEntityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to ensure the correct requirements are returned in the response. This parameter indicates whether the actual sender is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When not included, the request is assumed to be for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entity, as Wise has no way of knowing if the true sender on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/third-party-transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a business or private individual."},"children":[]}]}]}]},{"name":"addressRequired","in":"query","schemaId":"schema_840","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response always returns address as required, even if not required by the specific currency route."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include this query parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to force the address requirement regardless of currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address requirement fields are subject to change. Be sure to build your integration in a way that handles unrecognized or changed fields."},"children":[]}]}]}]}]}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Minor-Version","in":"header","schemaId":"schema_843","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the response includes both the recipient name and email fields, which are required to support currencies such as KRW, JPY and RUB."},"children":[]}]}]}]},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes/{quoteId}/account-requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"quoteId","in":"path","required":true,"schemaId":"schema_639"}],"query":[{"name":"originatorLegalEntityType","in":"query","required":false,"schemaId":"schema_842"},{"name":"addressRequired","in":"query","required":false,"schemaId":"schema_840"}],"querystring":[],"header":[{"name":"Accept-Minor-Version","in":"header","required":false,"schemaId":"schema_843"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429"],"pointer":"/quotes/{quoteId}/account-requirements","href":"recipient/recipientaccountrequirementsget","openApiOperationId":"recipientAccountRequirementsGet","summary":"Retrieve recipient account requirements dynamically"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Dynamic account requirements for building a recipient form.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-requirements-response"}},"schemaId":"components/schemas/account-requirements-response","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Unauthorized.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Not Found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/account-requirements-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-requirements-response"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientaccountrequirementsget"}],"panels":[]}]},"httpPath":"/quotes/{quoteId}/account-requirements"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientAccountRequirementsPost","name":"Retrieve additional recipient account requirements dynamically","isWebhook":false,"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve additional recipient account requirements dynamically","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refreshRequirementsOnChange=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group.key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientaccountrequirementsget#recipient/recipientaccountrequirementsget/response&c=200"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET response"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", send this POST request with the updated "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create recipient account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request payload. The response returns the additional required fields for that key based on the updated key value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field becomes required. To retrieve the list of valid state names, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientaccountrequirementspost"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to requery with the updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payload. The response returns the valid state names in the key’s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valuesAllowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quoteId","in":"path","schemaId":"schema_639","description":"Quote ID (supports long or UUID-based IDs).","required":true}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"originatorLegalEntityType","in":"query","schemaId":"schema_842","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal entity type override for the actual sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correspondent partners must include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originatorLegalEntityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to ensure the correct requirements are returned in the response. This parameter indicates whether the actual sender is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When not included, the request is assumed to be for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entity, as Wise has no way of knowing if the true sender on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/third-party-transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"third-party transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a business or private individual."},"children":[]}]}]}]}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Minor-Version","in":"header","schemaId":"schema_843","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the response includes both the recipient name and email fields, which are required to support currencies such as KRW, JPY and RUB."},"children":[]}]}]}]},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/recipient-create-request"}},"schemaId":"components/schemas/recipient-create-request","pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quotes/{quoteId}/account-requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"quoteId","in":"path","required":true,"schemaId":"schema_639"}],"query":[{"name":"originatorLegalEntityType","in":"query","required":false,"schemaId":"schema_842"}],"querystring":[],"header":[{"name":"Accept-Minor-Version","in":"header","required":false,"schemaId":"schema_843"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/recipient-create-request"}},"responseCodes":["200","429"],"pointer":"/quotes/{quoteId}/account-requirements","href":"recipient/recipientaccountrequirementspost","openApiOperationId":"recipientAccountRequirementsPost","summary":"Retrieve additional recipient account requirements dynamically"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/recipient-create-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/recipient-create-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated account requirements based on provided data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-requirements-response"}},"schemaId":"components/schemas/account-requirements-response","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1quotes~1{quoteId}~1account-requirements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/account-requirements-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/account-requirements-response"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientaccountrequirementspost"}],"panels":[]}]},"httpPath":"/quotes/{quoteId}/account-requirements"},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientCompatibilityCheck","name":"Check account and quote compatibility","isWebhook":false,"pointer":"/paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check account and quote compatibility","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to check the compatibility of a recipient account with a quote before creating a transfer. This validation includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-validating the recipient account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking all required fields are present (for example, recipient address for USD transfers)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying account details with the recipient's bank (for supported currencies)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is optional, but useful to identify potential issues before transfer creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The confirmations object is only populated for currencies that support "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/recipient-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If absent, only standard validations apply."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_650","description":"Recipient account ID.","required":true},{"name":"quoteId","in":"path","schemaId":"schema_647","description":"Quote ID.","required":true}],"pointer":"/paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{accountId}/quotes/{quoteId}/compatibility","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_650"},{"name":"quoteId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/accounts/{accountId}/quotes/{quoteId}/compatibility","href":"recipient/recipientcompatibilitycheck","openApiOperationId":"recipientCompatibilityCheck","summary":"Check account and quote compatibility"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the compatibility result, including any verification outcomes. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/recipient-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient verification guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about handling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_844","exampleIds":["paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_844","exampleIds":["paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_844","exampleIds":["paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_844","exampleIds":["paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientcompatibilitycheck"}],"panels":[]}]},"httpPath":"/accounts/{accountId}/quotes/{quoteId}/compatibility"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recipientConfirmationsAccept","name":"Accept confirmation outcomes","isWebhook":false,"pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept confirmation outcomes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the confirmation outcome indicates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"requiresCustomerAcceptance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the confirmation result contained a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the acceptance request must also specify that as part of the query parameters, otherwise the request will be rejected."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accountId","in":"path","schemaId":"schema_650","description":"Recipient account ID.","required":true}],"pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"quoteId","in":"query","schemaId":"schema_647","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if the confirmation result contained a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_845"}},"schemaId":"schema_845","pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/accounts/{accountId}/confirmations","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"accountId","in":"path","required":true,"schemaId":"schema_650"}],"query":[{"name":"quoteId","in":"query","required":false,"schemaId":"schema_647"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_845"}},"responseCodes":["200","429"],"pointer":"/accounts/{accountId}/confirmations","href":"recipient/recipientconfirmationsaccept","openApiOperationId":"recipientConfirmationsAccept","summary":"Accept confirmation outcomes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_845","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_845"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipient with updated confirmation status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}},"schemaId":"components/schemas/recipient","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1accounts~1{accountId}~1confirmations/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/recipient","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/recipient"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/recipientconfirmationsaccept"}],"panels":[]}]},"httpPath":"/accounts/{accountId}/confirmations"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventRecipientsStateChange","name":"Recipient state change","isWebhook":true,"pointer":"/paths/recipients#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a recipient account created or changed through hosted recipient creation changes state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows#hosted-recipient-creation-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an example recipient creation flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Ordering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipients#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/recipients#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_846"}},"schemaId":"schema_846","pointer":"/paths/recipients#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"recipients#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_846"}},"responseCodes":["200"],"pointer":"recipients#state-change","href":"recipient/eventrecipientsstatechange","openApiOperationId":"eventRecipientsStateChange","summary":"Recipient state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_846","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_846"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/recipients#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipient/eventrecipientsstatechange"}],"panels":[]}]},"httpPath":"recipients#state-change"}],"content":{"contentType":"group","meta":{"name":"recipient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient is the person receiving the funds. Sometimes called the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If using the pre-global versioned APIs (legacy), be sure to check the endpoint version path, as our recipient account endpoints use a mixture of v1 and v2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All recipient IDs are cross compatible with either version."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Recipient Account","link":"/recipient/recipient","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"List recipient accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recipient/recipientlist","deprecated":false},{"title":"/accounts","summary":"Create a recipient account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recipient/recipientcreate","deprecated":false},{"title":"/accounts/{accountId}","summary":"Get account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recipient/recipientget","deprecated":false},{"title":"/accounts/{accountId}","summary":"Deactivate a recipient account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recipient/recipientdeactivate","deprecated":false},{"title":"/quotes/{quoteId}/account-requirements","summary":"Retrieve recipient account requirements dynamically","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recipient/recipientaccountrequirementsget","deprecated":false},{"title":"/quotes/{quoteId}/account-requirements","summary":"Retrieve additional recipient account requirements dynamically","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recipient/recipientaccountrequirementspost","deprecated":false},{"title":"/accounts/{accountId}/quotes/{quoteId}/compatibility","summary":"Check account and quote compatibility","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recipient/recipientcompatibilitycheck","deprecated":false},{"title":"/accounts/{accountId}/confirmations","summary":"Accept confirmation outcomes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/recipient/recipientconfirmationsaccept","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"recipients#state-change","summary":"Recipient state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recipient/eventrecipientsstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"contactCreate","name":"Create a contact from an identifier","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contact from an identifier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finds an existing "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discoverable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response to create a transfer."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":12345678}],"pointer":"/paths/~1profiles~1{profileId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isDirectIdentifierCreation","in":"query","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for identifier-based contact creation."},"children":[]}]}]}],"required":true,"example":true}],"pointer":"/paths/~1profiles~1{profileId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_847","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_847","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1profiles~1{profileId}~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/contacts","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[{"name":"isDirectIdentifierCreation","in":"query","required":true,"example":true,"schemaId":"schema_657"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_847","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/contacts","href":"contact/contactcreate","openApiOperationId":"contactCreate","summary":"Create a contact from an identifier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_847","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_847","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_848","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_848","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_848","exampleIds":["paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact/contactcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/contacts"}],"content":{"contentType":"group","meta":{"name":"contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find discoverable Wise profiles and add them to your recipient list using an identifier — such as a Wisetag, email, or phone number — without needing bank details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{"class":{"title-3":true,"m-t-5":true}},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a transfer with a contact "},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote/quotecreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contactId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extract the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the Quote response — Wise resolves the contact into a recipient account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/standard-transfer/transfercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the Quote response."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/contacts","summary":"Create a contact from an identifier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact/contactcreate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transfers","content":null},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"transfer"},"seo":{"title":"Standard Transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Standard Transfer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/transfer"},"children":[]}]}]}},{"type":"link","label":"Originator Transfer","link":"/api-reference/transfer/originator-transfer","routeSlug":"/api-reference/transfer/originator-transfer","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"originator-transfer"},"seo":{"title":"Originator Transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Originator Transfer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/originator-transfer"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferGet","name":"Get a transfer by ID","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}","href":"transfer/transferget","openApiOperationId":"transferGet","summary":"Get a transfer by ID","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the transfer object, with or without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" block depending on the type of transfer."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_849"}},"schemaId":"schema_849","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_849","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_849"}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferget"}],"panels":[]}]},"httpPath":"/transfers/{transferId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferCancel","name":"Cancel a transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfers may be cancelled up until the transfer has been processed and funds converted. Cancellation is final — it cannot be undone."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"When can a transfer be cancelled?"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transfer can only be cancelled programmatically via the API if it meets "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the following criteria:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transfer is not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_converted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or later state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no processing problems with the transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the transfer does not meet these criteria, the API will return a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 Conflict"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error with the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer.cancellation.not.allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about transfer states, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking-transfers#transfer-statuses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transfers/{transferId}/cancel","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","409","429"],"pointer":"/transfers/{transferId}/cancel","href":"transfer/transfercancel","openApiOperationId":"transferCancel","summary":"Cancel a transfer","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the cancelled transfer object, with or without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" block depending on the type of transfer."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_849"}},"schemaId":"schema_849","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer cannot be cancelled because it is in a non-cancellable state or has other restrictions. The error response will include the code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer.cancellation.not.allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_849","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_849"}}},{"code":"404"},{"code":"409"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transfercancel"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/cancel"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferRequirementsValidate","name":"Validate transfer requirements","isWebhook":false,"pointer":"/paths/~1transfer-requirements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate transfer requirements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exposes transfer-specific requirements based on the sender, quote, and target recipient account. Requirements vary by currency route, transfer amount, and regulatory region."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the maximum allowed length of reference text varies — the US payment system (ACH) supports 10 characters only, but transfers within Mexico allow up to 100 characters. Similarly, depending on the chosen currencies and the amount to be transferred, Wise may require additional details such as source of funds or transfer purpose."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We highly recommend verifying transfer requirements before submitting any transfer to avoid delays caused by missing details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"success","name":"Integration guide"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/transfer-requirements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Requirements guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for step-by-step integration instructions and a list of common requirement fields."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfer-requirements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_850","exampleIds":["paths/~1transfer-requirements/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_850","exampleIds":["paths/~1transfer-requirements/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transfer-requirements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfer-requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_850","exampleIds":["paths/~1transfer-requirements/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/transfer-requirements","href":"transfer/transferrequirementsvalidate","openApiOperationId":"transferRequirementsValidate","summary":"Validate transfer requirements","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_850","exampleIds":["paths/~1transfer-requirements/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_850","exampleIds":["paths/~1transfer-requirements/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of transfer requirement objects describing the dynamic form fields.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851","exampleIds":["paths/~1transfer-requirements/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_851","exampleIds":["paths/~1transfer-requirements/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfer-requirements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_851","exampleIds":["paths/~1transfer-requirements/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_851","exampleIds":["paths/~1transfer-requirements/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferrequirementsvalidate"}],"panels":[]}]},"httpPath":"/transfer-requirements"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferFund","name":"Fund a Transfer","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund a Transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please read more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API call is the final step for executing payouts when using a balance with Wise. Upon calling the endpoint, Wise will begin the processing of the transfer, depending on the status of funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using the transfer by transfer settlement model, the following funding type(s) must be used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BALANCE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Funds are pulled from a multi-currency account held with Wise."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When funding through the Bulk Settlement model, the following funding type(s) must be used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRUSTED_PRE_FUND_BULK"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Funds for the transfer will be settled through a bulk payment at a later date. This method is not applicable for First Party partner account transfers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If funding from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and your multi-currency account does not have the required funds to complete the action, then this call will fail with an \"insufficient funds\" error. Once funds are added and available, you must call this endpoint again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_852","description":"Profile Id","required":true},{"name":"transferId","in":"path","schemaId":"schema_853","description":"Transfer Id","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundingRequest","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"]}},"schemaId":"components/schemas/FundingRequest","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/transfers/{transferId}/payments","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456789,"schemaId":"schema_852"},{"name":"transferId","in":"path","required":true,"example":16521632,"schemaId":"schema_853"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FundingRequest","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"]}},"responseCodes":["201","400","403","404","409","422","429","500"],"pointer":"/profiles/{profileId}/transfers/{transferId}/payments","href":"transfer/transferfund","openApiOperationId":"transferFund","summary":"Fund a Transfer","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/FundingRequest","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundingRequest","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"FundTransfer 201 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingResponse","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed"]}},"schemaId":"components/schemas/FundingResponse","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"InvalidRequestError 400 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"UnauthorisedAccessError 403 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"EntityNotFoundError 404 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"409","description":"PaymentAlreadyExistsError 409 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"UnsupportedOperationError 422 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"UnexpectedError 500 response","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}},"schemaId":"components/schemas/InvalidRequestErrorErrorPayload","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/FundingResponse","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingResponse","exampleIds":["paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds","paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed"]}}},{"code":"400","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}},{"code":"403","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}},{"code":"404","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}},{"code":"409","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}},{"code":"422","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"components/schemas/InvalidRequestErrorErrorPayload","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/InvalidRequestErrorErrorPayload"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferfund"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/transfers/{transferId}/payments"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferPaymentsList","name":"List completed payments","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List completed payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch completed payments used to fund the transfer.\n\nIn most cases there should only be a single payment associated with the transfer. There are rare occasions that a transfer can be funded with multiple payment methods and when this occurs the first completed payment method would be used to calculate the fees provided on the quote.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1payments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}/payments","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}/payments","href":"transfer/transferpaymentslist","openApiOperationId":"transferPaymentsList","summary":"List completed payments","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of completed payment objects.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_854"}},"schemaId":"schema_854","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_854","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_854"}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferpaymentslist"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/payments"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferPayoutInfoGet","name":"Get payout information","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payout information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch banking reference information for transfers that are in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, enabling you to track transfers with the transfer recipient's bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may take up to 3 days to get the correct information through this endpoint, as some partners don't share the information until 3 days later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}/invoices/bankingpartner","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}/invoices/bankingpartner","href":"transfer/transferpayoutinfoget","openApiOperationId":"transferPayoutInfoGet","summary":"Get payout information","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns payout information for the transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_855","exampleIds":["paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_855","exampleIds":["paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_855","exampleIds":["paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_855","exampleIds":["paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferpayoutinfoget"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/invoices/bankingpartner"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferReceiptGet","name":"Get a transfer receipt","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1receipt.pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transfer receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download transfer confirmation receipt in PDF format for transfers that are in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's also the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventtransfersstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer state change webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you service US retail consumers you must use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferuscombinedreceiptget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US combined receipt"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1receipt.pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1receipt.pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}/receipt.pdf","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}/receipt.pdf","href":"transfer/transferreceiptget","openApiOperationId":"transferReceiptGet","summary":"Get a transfer receipt","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer confirmation receipt in Wise branded PDF format.","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}},"schemaId":"schema_856","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1receipt.pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_856","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferreceiptget"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/receipt.pdf"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferUsCombinedReceiptGet","name":"Get a US combined disclosure receipt","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1us-combined-receipt.pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a US combined disclosure receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download US combined receipt in PDF format for transfers that are in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming_payment_initiated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and again when the status is updated to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1us-combined-receipt.pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1us-combined-receipt.pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}/us-combined-receipt.pdf","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}/us-combined-receipt.pdf","href":"transfer/transferuscombinedreceiptget","openApiOperationId":"transferUsCombinedReceiptGet","summary":"Get a US combined disclosure receipt","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The US Combined Receipt in Wise branded PDF format.","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}},"schemaId":"schema_856","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1us-combined-receipt.pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_856","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transferuscombinedreceiptget"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/us-combined-receipt.pdf"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferNocGet","name":"Get a non objection certificate (INR)","isWebhook":false,"pointer":"/paths/~1transfers~1{transferId}~1documents~1noc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a non objection certificate (INR)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download transfer non objection certificate in PDF format for transfers that are in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This document can be used to obtain a Foreign Inward Remittance Certificate (FIRC) from the bank that paid out the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is only applicable to INR payments with either a business sender or recipient."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The transfer ID","required":true}],"pointer":"/paths/~1transfers~1{transferId}~1documents~1noc/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers~1{transferId}~1documents~1noc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transferId}/documents/noc","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/transfers/{transferId}/documents/noc","href":"transfer/transfernocget","openApiOperationId":"transferNocGet","summary":"Get a non objection certificate (INR)","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Non objection certificate in PDF format.","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}},"schemaId":"schema_856","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers~1{transferId}~1documents~1noc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_856","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_856"}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/transfernocget"}],"panels":[]}]},"httpPath":"/transfers/{transferId}/documents/noc"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersActiveCases","name":"Transfer active cases","isWebhook":true,"pointer":"/paths/transfers#active-cases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer active cases","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transfer's list of active cases is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active cases indicate potential problems with transfer processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#active-cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#active-cases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/transfers#active-cases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#active-cases","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["200"],"pointer":"transfers#active-cases","href":"transfer/eventtransfersactivecases","openApiOperationId":"eventTransfersActiveCases","summary":"Transfer active cases"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#active-cases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/eventtransfersactivecases"}],"panels":[]}]},"httpPath":"transfers#active-cases"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersRefund","name":"Transfer refund","isWebhook":true,"pointer":"/paths/transfers#refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer refund","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In sandbox, the refund amount in this webhook is simulated. It may not reflect the amount in account balances or the sandbox UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationtransferstatechange#sandbox-refund"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulate transfer state change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about sandbox refund behaviour."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each event contains a timestamp. Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"schemaId":"schema_858","pointer":"/paths/transfers#refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#refund","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_858"}},"responseCodes":["200"],"pointer":"transfers#refund","href":"transfer/eventtransfersrefund","openApiOperationId":"eventTransfersRefund","summary":"Transfer refund"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_858","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/eventtransfersrefund"}],"panels":[]}]},"httpPath":"transfers#refund"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersPayoutFailure","name":"Transfer payout failure","isWebhook":true,"pointer":"/paths/transfers#payout-failure/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer payout failure","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a payout fails. Use this event to get further information about a failed payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#payout-failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventtransfersstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event provides high level information about the state of transfers, but it doesn't provide details about payout failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While a transfer is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the payout could fail for certain reasons. Additionally, not every payout failure will trigger a change in transfer state. For example a payout might fail with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANDATE_NOT_FILLED_IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but the corresponding transfer might stay in the same state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend processing both event types("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#payout-failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") separate from each other."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For available failure reason codes and descriptions, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that Wise can add new failure codes so your system should be able to handle the events even if the failure reason code is not recognised."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To simulate payout failure in sandbox, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationtransferpayoutfailure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout failure simulation endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#payout-failure/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"schemaId":"schema_859","pointer":"/paths/transfers#payout-failure/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#payout-failure","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_859"}},"responseCodes":["200"],"pointer":"transfers#payout-failure","href":"transfer/eventtransferspayoutfailure","openApiOperationId":"eventTransfersPayoutFailure","summary":"Transfer payout failure"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_859","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#payout-failure/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/eventtransferspayoutfailure"}],"panels":[]}]},"httpPath":"transfers#payout-failure"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersStateChange","name":"Transfer state change","isWebhook":true,"pointer":"/paths/transfers#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transfer's status is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup-to-balance transfers, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" triggered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To listen to these, subscribe to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/transfers#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["200"],"pointer":"transfers#state-change","href":"transfer/eventtransfersstatechange","openApiOperationId":"eventTransfersStateChange","summary":"Transfer state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer/eventtransfersstatechange"}],"panels":[]}]},"httpPath":"transfers#state-change"}],"content":{"contentType":"group","meta":{"name":"transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transfer is a payment order to a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once created, a transfer usually needs to be funded within fourteen days. Otherwise, it will be automatically cancelled."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Standard Transfer","link":"/transfer/transfer","deprecated":false},{"title":"Originator Transfer","link":"/transfer/originator-transfer","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers/{transferId}","summary":"Get a transfer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transferget","deprecated":false},{"title":"/transfers/{transferId}/cancel","summary":"Cancel a transfer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transfer/transfercancel","deprecated":false},{"title":"/transfer-requirements","summary":"Validate transfer requirements","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/transferrequirementsvalidate","deprecated":false},{"title":"/profiles/{profileId}/transfers/{transferId}/payments","summary":"Fund a Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/transferfund","deprecated":false},{"title":"/transfers/{transferId}/payments","summary":"List completed payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transferpaymentslist","deprecated":false},{"title":"/transfers/{transferId}/invoices/bankingpartner","summary":"Get payout information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transferpayoutinfoget","deprecated":false},{"title":"/transfers/{transferId}/receipt.pdf","summary":"Get a transfer receipt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transferreceiptget","deprecated":false},{"title":"/transfers/{transferId}/us-combined-receipt.pdf","summary":"Get a US combined disclosure receipt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transferuscombinedreceiptget","deprecated":false},{"title":"/transfers/{transferId}/documents/noc","summary":"Get a non objection certificate (INR)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer/transfernocget","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"transfers#active-cases","summary":"Transfer active cases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/eventtransfersactivecases","deprecated":false},{"title":"transfers#refund","summary":"Transfer refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/eventtransfersrefund","deprecated":false},{"title":"transfers#payout-failure","summary":"Transfer payout failure","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/eventtransferspayoutfailure","deprecated":false},{"title":"transfers#state-change","summary":"Transfer state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfer/eventtransfersstatechange","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferCreate","name":"Create a transfer","isWebhook":false,"pointer":"/paths/~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a transfer to a recipient account based on a quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some fields are conditionally required depending on the currency route and transfer amount. Always call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferrequirementsvalidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to determine which fields are needed, and submit values accordingly. These requirements may change over time."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"standard-transfer/transfercreate/request/avoiding-duplicate-transfers","deepLinkHash":"/standard-transfer/transfercreate#standard-transfer/transfercreate/request/avoiding-duplicate-transfers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Avoiding duplicate transfers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used to avoid duplicate transfer requests. If your initial call to create a transfer fails (error or timeout), retry the call using the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Subsequent retry messages are treated as repeat messages and will not create duplicate transfers. Use a sensible retry limit, ideally with a back-off approach."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"standard-transfer/transfercreate/request/payment-approvals","deepLinkHash":"/standard-transfer/transfercreate#standard-transfer/transfercreate/request/payment-approvals"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Approvals"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Payment Approvals created on your wise.com settings page are not compatible with creating transfers over the API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use personal tokens and do not use client credentials, and if your business account has payment approvals, your application will receive this error when attempting to create a transfer: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quote cannot be accepted with this request due to missing approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consider removing the payment rule if you are going to use the API to create transfers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_861","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/basic","paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"]}},"schemaId":"schema_861","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/basic","paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"],"pointer":"/paths/~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_861","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/basic","paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"]}},"responseCodes":["200","429"],"pointer":"/transfers","href":"standard-transfer/transfercreate","openApiOperationId":"transferCreate","summary":"Create a transfer","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_861","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/basic","paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_861","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/basic","paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer"}},"schemaId":"components/schemas/transfer","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/transfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standard-transfer/transfercreate"}],"panels":[]}]},"httpPath":"/transfers"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferList","name":"List transfers","isWebhook":false,"pointer":"/paths/~1transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of transfers for a given user's profile (defaults to user's personal profile).\n\nYou can add query parameters to specify user's profile (personal or business), time period and/or payment status. For example, you can query all failed payments created since last week, or all completed payments created since yesterday.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"profile","in":"query","schemaId":"schema_650","description":"User profile ID. If parameter is omitted, defaults to user's personal profile"},{"name":"status","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of one or more status codes to filter transfers. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for complete list of statuses"},"children":[]}]}]}]},{"name":"sourceCurrency","in":"query","schemaId":"schema_639","description":"Source currency code"},{"name":"targetCurrency","in":"query","schemaId":"schema_639","description":"Target currency code"},{"name":"createdDateStart","in":"query","schemaId":"schema_742","description":"Starting date to filter transfers, inclusive of the provided date"},{"name":"createdDateEnd","in":"query","schemaId":"schema_742","description":"Ending date to filter transfers, inclusive of the provided date"},{"name":"limit","in":"query","schemaId":"schema_628","description":"Maximum number of records to be returned in response"},{"name":"offset","in":"query","schemaId":"schema_628","description":"Starting record number"}],"pointer":"/paths/~1transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[{"name":"profile","in":"query","required":false,"schemaId":"schema_650"},{"name":"status","in":"query","required":false,"schemaId":"schema_639"},{"name":"sourceCurrency","in":"query","required":false,"schemaId":"schema_639"},{"name":"targetCurrency","in":"query","required":false,"schemaId":"schema_639"},{"name":"createdDateStart","in":"query","required":false,"schemaId":"schema_742"},{"name":"createdDateEnd","in":"query","required":false,"schemaId":"schema_742"},{"name":"limit","in":"query","required":false,"schemaId":"schema_628"},{"name":"offset","in":"query","required":false,"schemaId":"schema_628"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/transfers","href":"standard-transfer/transferlist","openApiOperationId":"transferList","summary":"List transfers","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of transfer objects, with or without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" block depending on the type of each transfer."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}},"schemaId":"schema_862","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_862","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_862"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standard-transfer/transferlist"}],"panels":[]}]},"httpPath":"/transfers"}],"content":{"contentType":"group","meta":{"name":"standard-transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Standard Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Create and manage transfers over API, either from your own Wise account or on behalf of your customers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers","summary":"Create a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/standard-transfer/transfercreate","deprecated":false},{"title":"/transfers","summary":"List transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standard-transfer/transferlist","deprecated":false}]}]}]}]}},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createThirdPartyTransfer","name":"Create a third party transfer","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a third party transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a transfer on behalf of a third party, you must take note that:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" datablock is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This details the ultimate sender of funds in the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the legal entity type of the originator ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the required fields vary. Please refer the sample request examples."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OriginalTransferId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be used. This is your own ID for the transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to save the transfer ID for tracking its status later via webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"third-party-transfer/createthirdpartytransfer/request/avoiding-duplicate-transfers","deepLinkHash":"/third-party-transfer/createthirdpartytransfer#third-party-transfer/createthirdpartytransfer/request/avoiding-duplicate-transfers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Avoiding duplicate transfers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalTransferId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used to avoid duplicate transfer requests. If your initial call fails (error or timeout), retry the call using the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalTransferId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Subsequent retry messages are treated as repeat messages and will not create duplicate transfers."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_863","description":"The profile ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateThirdPartyTransferRequestContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator","paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"]}},"schemaId":"components/schemas/CreateThirdPartyTransferRequestContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator","paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/third-party-transfers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456789,"schemaId":"schema_863"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateThirdPartyTransferRequestContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator","paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"]}},"responseCodes":["201","429"],"pointer":"/profiles/{profileId}/third-party-transfers","href":"third-party-transfer/createthirdpartytransfer","openApiOperationId":"createThirdPartyTransfer","summary":"Create a third party transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/CreateThirdPartyTransferRequestContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator","paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateThirdPartyTransferRequestContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator","paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Third party transfer successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity"]}},"schemaId":"components/schemas/CreateThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity"],"headers":{"Location":{"description":"Path to the created transfer","schema":{"type":"string","description":"Path to the created transfer","example":"/public/v2/profiles/123/third-party-transfers/16521632"}},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_864"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/third-party-transfer/createthirdpartytransfer"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/third-party-transfers"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getThirdPartyTransfer","name":"Get a third party transfer by ID","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a third party transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.wise.com/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_852","description":"Profile Id","required":true},{"name":"transferId","in":"path","schemaId":"schema_853","description":"Transfer Id","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/third-party-transfers/{transferId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":123456789,"schemaId":"schema_852"},{"name":"transferId","in":"path","required":true,"example":16521632,"schemaId":"schema_853"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/profiles/{profileId}/third-party-transfers/{transferId}","href":"third-party-transfer/getthirdpartytransfer","openApiOperationId":"getThirdPartyTransfer","summary":"Get a third party transfer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the originator transfer object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity"]}},"schemaId":"components/schemas/GetThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Transfer not found.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetThirdPartyTransferResponseContent","exampleIds":["paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity","paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity"]}}},{"code":"404"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/third-party-transfer/getthirdpartytransfer"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/third-party-transfers/{transferId}"}],"content":{"contentType":"group","meta":{"name":"third-party-transfer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Third Party Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Create and manage transfers over API on behalf of your customers, under your own financial license."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/third-party-transfers","summary":"Create a third party transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/third-party-transfer/createthirdpartytransfer","deprecated":false},{"title":"/profiles/{profileId}/third-party-transfers/{transferId}","summary":"Get a third party transfer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/third-party-transfer/getthirdpartytransfer","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deliveryEstimateGet","name":"Get the delivery estimate for a transfer","isWebhook":false,"pointer":"/paths/~1delivery-estimates~1{transferId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the delivery estimate for a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the live delivery estimate for a transfer by the transfer ID.\n\nThe delivery estimate is the time at which we currently expect the transfer to arrive in the beneficiary's bank account. This is not a guaranteed time but we are working hard to make these estimates as accurate as possible.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The ID of the transfer.","required":true,"example":12345678}],"pointer":"/paths/~1delivery-estimates~1{transferId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timezone","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone ID for the formatted text. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UTC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}],"example":"Asia/Singapore"}],"pointer":"/paths/~1delivery-estimates~1{transferId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1delivery-estimates~1{transferId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/delivery-estimates/{transferId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[{"name":"timezone","in":"query","required":false,"example":"Asia/Singapore","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/delivery-estimates/{transferId}","href":"delivery-estimate/deliveryestimateget","openApiOperationId":"deliveryEstimateGet","summary":"Get the delivery estimate for a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery estimate for the transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_865","exampleIds":["paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_865","exampleIds":["paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1delivery-estimates~1{transferId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_865","exampleIds":["paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_865","exampleIds":["paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-estimate/deliveryestimateget"}],"panels":[]}]},"httpPath":"/delivery-estimates/{transferId}"}],"content":{"contentType":"group","meta":{"name":"delivery-estimate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery Estimate","showPageActions":true},{"nodeType":"markdoc","content":"Get the estimated delivery time for a transfer, showing when funds are expected to arrive in the recipient's bank account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/delivery-estimates/{transferId}","summary":"Get the delivery estimate for a transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-estimate/deliveryestimateget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"currenciesGet","name":"Get all currencies allowed for transfers","isWebhook":false,"pointer":"/paths/~1currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all currencies allowed for transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all currencies available for creating transfers. Currency names are returned in English by default — pass an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to receive localized names."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locale code for localizing currency names (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"de"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (British English) if omitted or unsupported. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/language-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of supported languages."},"children":[]}]}]}],"example":"en"},{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currencies","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":false,"example":"en","schemaId":"schema_639"},{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/currencies","href":"currencies/currenciesget","openApiOperationId":"currenciesGet","summary":"Get all currencies allowed for transfers","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of currencies allowed for transfers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_866","exampleIds":["paths/~1currencies/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_866","exampleIds":["paths/~1currencies/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_866","exampleIds":["paths/~1currencies/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_866","exampleIds":["paths/~1currencies/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currencies/currenciesget"}],"panels":[]}]},"httpPath":"/currencies"}],"content":{"contentType":"group","meta":{"name":"currencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currencies","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve the list of currencies supported for transfers, including currency codes and display names."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/currencies","summary":"Get all currencies allowed for transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currencies/currenciesget","deprecated":false}]}]}]}]}},{"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","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BatchGroup"},"seo":{"title":"Batch Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Group","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BatchGroup"},"children":[]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupCreate","name":"Create a batch group","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a batch group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new batch group.\n\nA batch group can hold up to 1000 transfers that will be funded together. After creating the group, add transfers to it, then complete the group to receive pay-in details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile to create the batch group for.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_867"}},"schemaId":"schema_867","pointer":"/paths/~1profiles~1{profileId}~1batch-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/batch-groups","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_867"}},"responseCodes":["201","429"],"pointer":"/profiles/{profileId}/batch-groups","href":"batch-group/batchgroupcreate","openApiOperationId":"batchGroupCreate","summary":"Create a batch group","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_867","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_867"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch group created successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payInDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty for newly created batch groups."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup","exampleIds":["paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/BatchGroup","exampleIds":["paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/BatchGroup","exampleIds":["paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup","exampleIds":["paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgroupcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupGet","name":"Retrieve a batch group","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a batch group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an existing batch group by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/batch-groups/{batchGroupId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-groups/{batchGroupId}","href":"batch-group/batchgroupget","openApiOperationId":"batchGroupGet","summary":"Retrieve a batch group","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch group retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup"}},"schemaId":"components/schemas/BatchGroup","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgroupget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupUpdate","name":"Update batch group status","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update batch group status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a batch group's status to complete or cancel it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete a batch group:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to close the group for modifications and allow funding to proceed. Once completed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payInDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be populated with funding instructions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a batch group:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to cancel all transfers in the batch. Only batches that are not funded can be cancelled. Cancellation is final and cannot be undone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is required for concurrency control. The operation will be rejected if the provided version does not match the server's current version."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"schemaId":"schema_869","pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/profiles/{profileId}/batch-groups/{batchGroupId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_869"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-groups/{batchGroupId}","href":"batch-group/batchgroupupdate","openApiOperationId":"batchGroupUpdate","summary":"Update batch group status","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_869","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_869"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch group updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup"}},"schemaId":"components/schemas/BatchGroup","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchGroup"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgroupupdate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupTransferCreate","name":"Create a batch group transfer","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a batch group transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a transfer in the batch group using a previously created recipient account and quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the request body format, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer#create"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For quote and recipient creation, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote/quotecreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quote creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/recipient/recipientcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recipient creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1transfers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_870"}},"schemaId":"schema_870","pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/batch-groups/{batchGroupId}/transfers","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_870"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-groups/{batchGroupId}/transfers","href":"batch-group/batchgrouptransfercreate","openApiOperationId":"batchGroupTransferCreate","summary":"Create a batch group transfer","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_870","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_870"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer created successfully. Returns a transfer object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}},"schemaId":"schema_871","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_871","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_871"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgrouptransfercreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/transfers"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupFund","name":"Fund a batch group","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-payments~1{batchGroupId}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund a batch group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds all transfers in a batch group from a multi-currency account balance. Transfers are paid out immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch group must first be completed, and there must be enough funds in the account for the whole batch. Otherwise, an insufficient funds error will be returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. For more information, please read "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-payments~1{batchGroupId}~1payments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-payments~1{batchGroupId}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_872"}},"schemaId":"schema_872","pointer":"/paths/~1profiles~1{profileId}~1batch-payments~1{batchGroupId}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/batch-payments/{batchGroupId}/payments","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_872"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-payments/{batchGroupId}/payments","href":"batch-group/batchgroupfund","openApiOperationId":"batchGroupFund","summary":"Fund a batch group","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_872","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_872"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch group funded successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}},"schemaId":"schema_873","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-payments~1{batchGroupId}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_873","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_873"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgroupfund"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-payments/{batchGroupId}/payments"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupPaymentInitiationCreate","name":"Fund a batch group via direct debit","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund a batch group via direct debit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds all transfers in a batch group via direct debit. The batch group must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this funding method, you need to link an external bank account first. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/direct-debit-account/directdebitaccountcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct debit account creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. For more information, please read "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/auth-and-security/sca-and-2fa"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementing SCA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"schemaId":"schema_874","pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_874"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations","href":"batch-group/batchgrouppaymentinitiationcreate","openApiOperationId":"batchGroupPaymentInitiationCreate","summary":"Fund a batch group via direct debit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_874","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_874"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment initiation created successfully. You need to save payment initiation ID for tracking its status later.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInitiation"}},"schemaId":"components/schemas/PaymentInitiation","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInitiation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInitiation"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgrouppaymentinitiationcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchGroupPaymentInitiationGet","name":"Retrieve a payment initiation","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations~1{paymentInitiationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a payment initiation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get payment initiation info by ID. In addition to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventbatchpaymentinitiationsstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this endpoint can be used for polling the status of a payment initiation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]},{"schemes":[{"name":"PersonalToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_745","description":"The ID of the profile that the batch group is associated with.","required":true},{"name":"batchGroupId","in":"path","schemaId":"schema_868","description":"The batch group ID.","required":true},{"name":"paymentInitiationId","in":"path","schemaId":"schema_875","description":"The payment initiation ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations~1{paymentInitiationId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations~1{paymentInitiationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_745"},{"name":"batchGroupId","in":"path","required":true,"example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","schemaId":"schema_868"},{"name":"paymentInitiationId","in":"path","required":true,"example":12345,"schemaId":"schema_875"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}","href":"batch-group/batchgrouppaymentinitiationget","openApiOperationId":"batchGroupPaymentInitiationGet","summary":"Retrieve a payment initiation","securityGroups":[{"UserToken":[]},{"PersonalToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment initiation retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInitiation"}},"schemaId":"components/schemas/PaymentInitiation","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1batch-groups~1{batchGroupId}~1payment-initiations~1{paymentInitiationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInitiation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInitiation"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/batchgrouppaymentinitiationget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBatchPaymentInitiationsStateChange","name":"Batch payment initiations state change","isWebhook":true,"pointer":"/paths/batch-payment-initiations#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch payment initiations state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the payment initiation state of a batch group payment changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expected state of a batch payment initiation can be one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGED_BACK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch-payment-initiations#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/batch-payment-initiations#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_876"}},"schemaId":"schema_876","pointer":"/paths/batch-payment-initiations#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"batch-payment-initiations#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_876"}},"responseCodes":["200"],"pointer":"batch-payment-initiations#state-change","href":"batch-group/eventbatchpaymentinitiationsstatechange","openApiOperationId":"eventBatchPaymentInitiationsStateChange","summary":"Batch payment initiations state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_876","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_876"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/batch-payment-initiations#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-group/eventbatchpaymentinitiationsstatechange"}],"panels":[]}]},"httpPath":"batch-payment-initiations#state-change"}],"content":{"contentType":"group","meta":{"name":"batch-group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Payment Groups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch group is a named collection of up to 1000 transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workflow:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a batch group with a source currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add transfers to the group (up to 1000)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete the batch group to close it for modifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund the batch group from a balance or via direct debit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual transfers in the group follow standard transfer lifecycle and can be tracked separately."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Batch Group","link":"/batch-group/batchgroup","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/batch-groups","summary":"Create a batch group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-group/batchgroupcreate","deprecated":false},{"title":"/profiles/{profileId}/batch-groups/{batchGroupId}","summary":"Retrieve a batch group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-group/batchgroupget","deprecated":false},{"title":"/profiles/{profileId}/batch-groups/{batchGroupId}","summary":"Update batch group status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/batch-group/batchgroupupdate","deprecated":false},{"title":"/profiles/{profileId}/batch-groups/{batchGroupId}/transfers","summary":"Create a batch group transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-group/batchgrouptransfercreate","deprecated":false},{"title":"/profiles/{profileId}/batch-payments/{batchGroupId}/payments","summary":"Fund a batch group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-group/batchgroupfund","deprecated":false},{"title":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations","summary":"Fund a batch group via direct debit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-group/batchgrouppaymentinitiationcreate","deprecated":false},{"title":"/profiles/{profileId}/batch-groups/{batchGroupId}/payment-initiations/{paymentInitiationId}","summary":"Retrieve a payment initiation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-group/batchgrouppaymentinitiationget","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"batch-payment-initiations#state-change","summary":"Batch payment initiations state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-group/eventbatchpaymentinitiationsstatechange","deprecated":false}]}]}]}]}},{"type":"separator","label":"Funding","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payinDepositDetailGet","name":"Retrieve bank transfer deposit details","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1deposit-details~1bank-transfer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve bank transfer deposit details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profileId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request URL refers to the profile that created the transfer. It can be either the personal profile ID, or the business profile ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payinBankAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field allows the bank details to be displayed dynamically in a user interface, by displaying the label and value fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, this API supports the following currencies: AUD, BGN, BRL, CAD, CHF, CZK, DKK, EUR, GBP, HKD, HRK, HUF, IDR, INR, JPY, MYR, NOK, NZD, PLN, RON, SEK, SGD, TRY, USD."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID.","required":true},{"name":"transferId","in":"path","schemaId":"schema_650","description":"Transfer ID.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1deposit-details~1bank-transfer/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1deposit-details~1bank-transfer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer","href":"payin-deposit-detail/payindepositdetailget","openApiOperationId":"payinDepositDetailGet","summary":"Retrieve bank transfer deposit details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payin deposit detail object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_877"}},"schemaId":"schema_877","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1transfers~1{transferId}~1deposit-details~1bank-transfer/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_877","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_877"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payin-deposit-detail/payindepositdetailget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer"}],"content":{"contentType":"group","meta":{"name":"payin-deposit-detail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payin Deposit Detail","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payin deposit details API allows you to get the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details will be provided in the local format for that currency and usually contain bank account information — like IBAN, SWIFT code etc. It also includes the name and address of the receiving bank and the name and address of the Wise entity that owns the bank account, as sometimes these are required to make a payment."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer","summary":"Retrieve bank transfer deposit details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payin-deposit-detail/payindepositdetailget","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directDebitAccountCreate","name":"Create a direct debit account","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a direct debit account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Register a new external bank account for funding batch transfers via direct debit.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":12345678}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_878"}},"schemaId":"schema_878","pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/direct-debit-accounts","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_878"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/direct-debit-accounts","href":"direct-debit-account/directdebitaccountcreate","openApiOperationId":"directDebitAccountCreate","summary":"Create a direct debit account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_878","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_878"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Direct debit account created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectDebitAccount"}},"schemaId":"components/schemas/DirectDebitAccount","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectDebitAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectDebitAccount"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debit-account/directdebitaccountcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/direct-debit-accounts"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"directDebitAccountGet","name":"Retrieve all direct debit accounts","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all direct debit accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of your direct debit accounts. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters to filter accounts."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Your profile ID.","required":true,"example":12345678}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_879","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for which the account is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — US direct debit (USD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — CA direct debit (CAD)"},"children":[]}]}]}]}],"required":true,"example":"ACH"},{"name":"currency","in":"query","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the bank account. 3-character currency code — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ACH direct debits, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for EFT direct debits."},"children":[]}]}]}],"required":true,"example":"USD"}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/direct-debit-accounts","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[{"name":"type","in":"query","required":true,"example":"ACH","schemaId":"schema_879"},{"name":"currency","in":"query","required":true,"example":"USD","schemaId":"schema_639"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/direct-debit-accounts","href":"direct-debit-account/directdebitaccountget","openApiOperationId":"directDebitAccountGet","summary":"Retrieve all direct debit accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of direct debit accounts matching the filters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}},"schemaId":"schema_880","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1direct-debit-accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_880","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_880"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/direct-debit-account/directdebitaccountget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/direct-debit-accounts"}],"content":{"contentType":"group","meta":{"name":"direct-debit-account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Direct Debit Account","showPageActions":true},{"nodeType":"markdoc","content":"Register and retrieve external bank accounts used to fund batch transfers via ACH (USD) or EFT (CAD) direct debit."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/direct-debit-accounts","summary":"Create a direct debit account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/direct-debit-account/directdebitaccountcreate","deprecated":false},{"title":"/profiles/{profileId}/direct-debit-accounts","summary":"Retrieve all direct debit accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/direct-debit-account/directdebitaccountget","deprecated":false}]}]}]}]}},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkSettlementJournalCreate","name":"Send a settlement journal","isWebhook":false,"pointer":"/paths/~1settlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a settlement journal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends the settlement journal to Wise. There are two types of settlement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same Currency Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Settle in the same currency as the transfers (e.g., settle USD transfers with USD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cross Currency Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Settle in a different currency (e.g., settle PHP transfers with USD). In this case, you must specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use a client credentials token to authenticate this call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1settlements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_881","exampleIds":["paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency","paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"]}},"schemaId":"schema_881","exampleIds":["paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency","paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"],"pointer":"/paths/~1settlements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settlements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_881","exampleIds":["paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency","paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"]}},"responseCodes":["200","429"],"pointer":"/settlements","href":"bulk-settlement/bulksettlementjournalcreate","openApiOperationId":"bulkSettlementJournalCreate","summary":"Send a settlement journal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_881","exampleIds":["paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency","paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_881","exampleIds":["paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency","paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Settlement journal received successfully. Empty response body.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1settlements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-settlement/bulksettlementjournalcreate"}],"panels":[]}]},"httpPath":"/settlements"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBulkSettlementPaymentReceived","name":"Bulk settlement payment received","isWebhook":true,"pointer":"/paths/bulk-settlement#payment-received/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk settlement payment received","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_matched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If it is not matched, check the difference between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine how much more needs to be paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event can also be triggered when our operations team reallocates funds between settlements. Therefore, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in version 2.0.0 of the webhook is inaccurate. Please use the latest version, 4.0.0. Version 2.0.0 is deprecated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk-settlement#payment-received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/bulk-settlement#payment-received/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_882"}},"schemaId":"schema_882","pointer":"/paths/bulk-settlement#payment-received/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"bulk-settlement#payment-received","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_882"}},"responseCodes":["200"],"pointer":"bulk-settlement#payment-received","href":"bulk-settlement/eventbulksettlementpaymentreceived","openApiOperationId":"eventBulkSettlementPaymentReceived","summary":"Bulk settlement payment received"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_882","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_882"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/bulk-settlement#payment-received/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-settlement/eventbulksettlementpaymentreceived"}],"panels":[]}]},"httpPath":"bulk-settlement#payment-received"}],"content":{"contentType":"group","meta":{"name":"bulk-settlement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Settlement","showPageActions":true},{"nodeType":"markdoc","content":"Bulk settlement allows partners to settle multiple transfers in a single bank transfer at the end of a settlement period. This model splits transfer creation/funding from final settlement, allowing Wise to process transfers before receiving funds based on a partner's guarantee.\n\nUse the settlement journal endpoint to submit a list of transfers to be settled, along with the settlement reference that matches your bank transfer payment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settlements","summary":"Send a settlement journal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-settlement/bulksettlementjournalcreate","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"bulk-settlement#payment-received","summary":"Bulk settlement payment received","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-settlement/eventbulksettlementpaymentreceived","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"paynowCreate","name":"Create PayNow payment details","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1payin-sessions~1{payinSessionId}~1paynow/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create PayNow payment details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates the encoded QR code and details for the payin session so the user can fund a transfer or balance top-up via a PayNow transaction.\nThis operation supports the SGD currency only.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"Profile ID of the profile that created the transfer.","required":true},{"name":"payinSessionId","in":"path","schemaId":"schema_732","description":"Payin Session ID retrieved from Transfer object.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1payin-sessions~1{payinSessionId}~1paynow/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1payin-sessions~1{payinSessionId}~1paynow/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"payinSessionId","in":"path","required":true,"schemaId":"schema_732"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","422","429"],"pointer":"/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow","href":"payins/paynowcreate","openApiOperationId":"paynowCreate","summary":"Create PayNow payment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"PayNow payment object.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883"}},"schemaId":"schema_883","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_884"}},"schemaId":"schema_884","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"Unprocessable request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}},"schemaId":"schema_885","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1payin-sessions~1{payinSessionId}~1paynow/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_883","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_883"}}},{"code":"400","schemaId":"schema_884","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_884"}}},{"code":"422","schemaId":"schema_885","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_885"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payins/paynowcreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow"}],"content":{"contentType":"group","meta":{"name":"payins"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payins","showPageActions":true},{"nodeType":"markdoc","content":"The payin APIs allow you to fund the MCA or transfers with local payment rails, by retrieving or creating the relevant details to send to for funding a payment. \n\nThese details will be provided in the local format for that currency, and also includes the name and address of the receiving bank."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{profileId}/payin-sessions/{payinSessionId}/paynow","summary":"Create PayNow payment details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payins/paynowcreate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookApplicationSubscriptionCreate","name":"Create Application Webhook Subscription","isWebhook":false,"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Application Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a webhook subscription at the application level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be received upon obtaining client credentials from our tech support."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientKey","in":"path","schemaId":"schema_639","description":"Your application's client key.","required":true}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"schemaId":"components/schemas/subscription-request","pointer":"/paths/~1applications~1{clientKey}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{clientKey}/subscriptions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientKey","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"responseCodes":["200","429"],"pointer":"/applications/{clientKey}/subscriptions","href":"webhook/webhookapplicationsubscriptioncreate","openApiOperationId":"webhookApplicationSubscriptionCreate","summary":"Create Application Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/subscription-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookapplicationsubscriptioncreate"}],"panels":[]}]},"httpPath":"/applications/{clientKey}/subscriptions"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookApplicationSubscriptionList","name":"List Application Webhook Subscriptions","isWebhook":false,"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Application Webhook Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all webhook subscriptions for your application."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientKey","in":"path","schemaId":"schema_639","description":"Your application's client key.","required":true}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{clientKey}/subscriptions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientKey","in":"path","required":true,"schemaId":"schema_639"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/applications/{clientKey}/subscriptions","href":"webhook/webhookapplicationsubscriptionlist","openApiOperationId":"webhookApplicationSubscriptionList","summary":"List Application Webhook Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_886"}},"schemaId":"schema_886","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_886","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_886"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookapplicationsubscriptionlist"}],"panels":[]}]},"httpPath":"/applications/{clientKey}/subscriptions"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookApplicationSubscriptionGet","name":"Get Application Webhook Subscription","isWebhook":false,"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Application Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an application webhook subscription by its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientKey","in":"path","schemaId":"schema_639","description":"Your application's client key.","required":true},{"name":"subscriptionId","in":"path","schemaId":"schema_647","description":"UUID of the subscription.","required":true}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{clientKey}/subscriptions/{subscriptionId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientKey","in":"path","required":true,"schemaId":"schema_639"},{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/applications/{clientKey}/subscriptions/{subscriptionId}","href":"webhook/webhookapplicationsubscriptionget","openApiOperationId":"webhookApplicationSubscriptionGet","summary":"Get Application Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}},"schemaId":"components/schemas/subscription","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookapplicationsubscriptionget"}],"panels":[]}]},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookApplicationSubscriptionDelete","name":"Delete Application Webhook Subscription","isWebhook":false,"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Application Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an application webhook subscription by its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientKey","in":"path","schemaId":"schema_639","description":"Your application's client key.","required":true},{"name":"subscriptionId","in":"path","schemaId":"schema_647","description":"UUID of the subscription.","required":true}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applications/{clientKey}/subscriptions/{subscriptionId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientKey","in":"path","required":true,"schemaId":"schema_639"},{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","429"],"pointer":"/applications/{clientKey}/subscriptions/{subscriptionId}","href":"webhook/webhookapplicationsubscriptiondelete","openApiOperationId":"webhookApplicationSubscriptionDelete","summary":"Delete Application Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookapplicationsubscriptiondelete"}],"panels":[]}]},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookApplicationSubscriptionTest","name":"Test Application Webhook Subscription","isWebhook":false,"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}~1test-notifications/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Application Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate test notifications for an existing application subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test notifications will have the correct structure for their source subscription's event type and version, and will contain \"dummy\" data. These data include random UUIDs, entity IDs of zero, current dates and times, and hard-coded status codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test notifications are delivered with the usual notification HTTP request headers, including a unique delivery ID for the notification, and a \"test notification\" flag set to true. You can check for the presence of this test flag to determine that an incoming notification is a test notification which should not be processed as real data. See the section "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event HTTP requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on request headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When test notifications are created with the API, they are queued for sending in the same way as non-test notifications. This means that there may be some delay in notification delivery, and delivery failures will result in attempts to redeliver the notification later. The API returns the delivery IDs of the notifications that have been successfully queued for sending, which can be correlated with the delivery ID header values for notifications you later receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This test notification API is only available for application-based subscriptions. Profile-based subscriptions do not currently support this testing feature."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientKey","in":"path","schemaId":"schema_639","description":"Your application's client key.","required":true},{"name":"subscriptionId","in":"path","schemaId":"schema_647","description":"UUID of the subscription.","required":true}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}~1test-notifications/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}~1test-notifications/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"clientKey","in":"path","required":true,"schemaId":"schema_639"},{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications","href":"webhook/webhookapplicationsubscriptiontest","openApiOperationId":"webhookApplicationSubscriptionTest","summary":"Test Application Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_887"}},"schemaId":"schema_887","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1applications~1{clientKey}~1subscriptions~1{subscriptionId}~1test-notifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_887","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_887"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookapplicationsubscriptiontest"}],"panels":[]}]},"httpPath":"/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookProfileSubscriptionCreate","name":"Create Profile Webhook Subscription","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Profile Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a webhook subscription at the profile level."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"ID of the profile you are subscribing to.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"schemaId":"components/schemas/subscription-request","pointer":"/paths/~1profiles~1{profileId}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{profileId}/subscriptions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/subscriptions","href":"webhook/webhookprofilesubscriptioncreate","openApiOperationId":"webhookProfileSubscriptionCreate","summary":"Create Profile Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/subscription-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscription-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookprofilesubscriptioncreate"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/subscriptions"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookProfileSubscriptionList","name":"List Profile Webhook Subscriptions","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Profile Webhook Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all webhook subscriptions for a profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"ID of the profile.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/subscriptions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/subscriptions","href":"webhook/webhookprofilesubscriptionlist","openApiOperationId":"webhookProfileSubscriptionList","summary":"List Profile Webhook Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_886","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_886","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_886","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_886","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookprofilesubscriptionlist"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/subscriptions"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookProfileSubscriptionGet","name":"Get Profile Webhook Subscription","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Profile Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a profile webhook subscription by its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"ID of the profile.","required":true},{"name":"subscriptionId","in":"path","schemaId":"schema_647","description":"UUID of the subscription.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{profileId}/subscriptions/{subscriptionId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/profiles/{profileId}/subscriptions/{subscriptionId}","href":"webhook/webhookprofilesubscriptionget","openApiOperationId":"webhookProfileSubscriptionGet","summary":"Get Profile Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookprofilesubscriptionget"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/subscriptions/{subscriptionId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookProfileSubscriptionDelete","name":"Delete Profile Webhook Subscription","isWebhook":false,"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Profile Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a profile webhook subscription by its identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"ID of the profile.","required":true},{"name":"subscriptionId","in":"path","schemaId":"schema_647","description":"UUID of the subscription.","required":true}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{profileId}/subscriptions/{subscriptionId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"subscriptionId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","429"],"pointer":"/profiles/{profileId}/subscriptions/{subscriptionId}","href":"webhook/webhookprofilesubscriptiondelete","openApiOperationId":"webhookProfileSubscriptionDelete","summary":"Delete Profile Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/webhookprofilesubscriptiondelete"}],"panels":[]}]},"httpPath":"/profiles/{profileId}/subscriptions/{subscriptionId}"}],"content":{"contentType":"group","meta":{"name":"webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage webhook subscriptions at both the application and profile level. Create, list, retrieve, and delete subscriptions, as well as test your webhook endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on creating and managing webhooks, and specific event types, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks & Notifications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applications/{clientKey}/subscriptions","summary":"Create Application Webhook Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/webhookapplicationsubscriptioncreate","deprecated":false},{"title":"/applications/{clientKey}/subscriptions","summary":"List Application Webhook Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/webhookapplicationsubscriptionlist","deprecated":false},{"title":"/applications/{clientKey}/subscriptions/{subscriptionId}","summary":"Get Application Webhook Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/webhookapplicationsubscriptionget","deprecated":false},{"title":"/applications/{clientKey}/subscriptions/{subscriptionId}","summary":"Delete Application Webhook Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/webhookapplicationsubscriptiondelete","deprecated":false},{"title":"/applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications","summary":"Test Application Webhook Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/webhookapplicationsubscriptiontest","deprecated":false},{"title":"/profiles/{profileId}/subscriptions","summary":"Create Profile Webhook Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/webhookprofilesubscriptioncreate","deprecated":false},{"title":"/profiles/{profileId}/subscriptions","summary":"List Profile Webhook Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/webhookprofilesubscriptionlist","deprecated":false},{"title":"/profiles/{profileId}/subscriptions/{subscriptionId}","summary":"Get Profile Webhook Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/webhookprofilesubscriptionget","deprecated":false},{"title":"/profiles/{profileId}/subscriptions/{subscriptionId}","summary":"Delete Profile Webhook Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/webhookprofilesubscriptiondelete","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersActiveCases","name":"Transfer active cases","isWebhook":true,"pointer":"/paths/transfers#active-cases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer active cases","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transfer's list of active cases is updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active cases indicate potential problems with transfer processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#active-cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#active-cases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"schemaId":"schema_857","pointer":"/paths/transfers#active-cases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#active-cases","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_857"}},"responseCodes":["200"],"pointer":"transfers#active-cases","href":"webhook-event/eventtransfersactivecases","openApiOperationId":"eventTransfersActiveCases","summary":"Transfer active cases"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_857","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_857"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#active-cases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventtransfersactivecases"}],"panels":[]}]},"httpPath":"transfers#active-cases"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersRefund","name":"Transfer refund","isWebhook":true,"pointer":"/paths/transfers#refund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer refund","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event provides information about refund amount and currency. Triggered every time a transfer's status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In sandbox, the refund amount in this webhook is simulated. It may not reflect the amount in account balances or the sandbox UI. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationtransferstatechange#sandbox-refund"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulate transfer state change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about sandbox refund behaviour."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each event contains a timestamp. Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#refund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"schemaId":"schema_858","pointer":"/paths/transfers#refund/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#refund","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_858"}},"responseCodes":["200"],"pointer":"transfers#refund","href":"webhook-event/eventtransfersrefund","openApiOperationId":"eventTransfersRefund","summary":"Transfer refund"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_858","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_858"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#refund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventtransfersrefund"}],"panels":[]}]},"httpPath":"transfers#refund"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersPayoutFailure","name":"Transfer payout failure","isWebhook":true,"pointer":"/paths/transfers#payout-failure/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer payout failure","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a payout fails. Use this event to get further information about a failed payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#payout-failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventtransfersstatechange"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event provides high level information about the state of transfers, but it doesn't provide details about payout failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While a transfer is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the payout could fail for certain reasons. Additionally, not every payout failure will trigger a change in transfer state. For example a payout might fail with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANDATE_NOT_FILLED_IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but the corresponding transfer might stay in the same state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend processing both event types("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#payout-failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") separate from each other."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For available failure reason codes and descriptions, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that Wise can add new failure codes so your system should be able to handle the events even if the failure reason code is not recognised."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To simulate payout failure in sandbox, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationtransferpayoutfailure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout failure simulation endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#payout-failure/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"schemaId":"schema_859","pointer":"/paths/transfers#payout-failure/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#payout-failure","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_859"}},"responseCodes":["200"],"pointer":"transfers#payout-failure","href":"webhook-event/eventtransferspayoutfailure","openApiOperationId":"eventTransfersPayoutFailure","summary":"Transfer payout failure"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_859","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_859"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#payout-failure/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventtransferspayoutfailure"}],"panels":[]}]},"httpPath":"transfers#payout-failure"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransfersStateChange","name":"Transfer state change","isWebhook":true,"pointer":"/paths/transfers#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transfer's status is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For topup-to-balance transfers, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" triggered."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To listen to these, subscribe to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transfers#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"schemaId":"schema_860","pointer":"/paths/transfers#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_860"}},"responseCodes":["200"],"pointer":"transfers#state-change","href":"webhook-event/eventtransfersstatechange","openApiOperationId":"eventTransfersStateChange","summary":"Transfer state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_860","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_860"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transfers#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventtransfersstatechange"}],"panels":[]}]},"httpPath":"transfers#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventAccountDetailsOrderStateChange","name":"Account details order state change","isWebhook":true,"pointer":"/paths/account-details-order#order-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account details order state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account-details-order#order-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values for an order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One or more requirements has some pending action from the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_TW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One or more requirements has some pending action from Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All requirements are completed and pending account details to be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All requirements are completed and account details has also been created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/account-details-order-state-flow.208d24156d3d1cfd3d0e3ce910f5c0b9f016f9152a3cbcbc648a67e5fc545c7f.28b10c14.png","alt":"Create account details order statuses transition diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most common requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user needs to be fully verified before completing this requirement."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.modification_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/account-details-order#order-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758","pointer":"/paths/account-details-order#order-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"account-details-order#order-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_758"}},"responseCodes":["200"],"pointer":"account-details-order#order-state-change","href":"webhook-event/eventaccountdetailsorderstatechange","openApiOperationId":"eventAccountDetailsOrderStateChange","summary":"Account details order state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_758"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/account-details-order#order-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventaccountdetailsorderstatechange"}],"panels":[]}]},"httpPath":"account-details-order#order-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventAccountDetailsPaymentStateChange","name":"Account details payment state change","isWebhook":true,"pointer":"/paths/account-details-payment#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account details payment state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a pay-in is made into the specified account details."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account-details-payment#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/account-details-payment#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_759"}},"schemaId":"schema_759","pointer":"/paths/account-details-payment#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"account-details-payment#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_759"}},"responseCodes":["200"],"pointer":"account-details-payment#state-change","href":"webhook-event/eventaccountdetailspaymentstatechange","openApiOperationId":"eventAccountDetailsPaymentStateChange","summary":"Account details payment state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_759","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_759"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/account-details-payment#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventaccountdetailspaymentstatechange"}],"panels":[]}]},"httpPath":"account-details-payment#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardStatusChange","name":"Card status change","isWebhook":true,"pointer":"/paths/cards#card-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event is triggered for the initial card status as well as any subsequent updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_772"}},"schemaId":"schema_772","pointer":"/paths/cards#card-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_772"}},"responseCodes":["200"],"pointer":"cards#card-status-change","href":"webhook-event/eventcardscardstatuschange","openApiOperationId":"eventCardsCardStatusChange","summary":"Card status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_772","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_772"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcardscardstatuschange"}],"panels":[]}]},"httpPath":"cards#card-status-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardProductionStatusChange","name":"Card production status change","isWebhook":true,"pointer":"/paths/cards#card-production-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card production status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a card production status is updated. This webhook is solely used for physical cards with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KIOSK_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-kiosk-collection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card kiosk collection guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-production-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-production-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_781"}},"schemaId":"schema_781","pointer":"/paths/cards#card-production-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-production-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_781"}},"responseCodes":["200"],"pointer":"cards#card-production-status-change","href":"webhook-event/eventcardscardproductionstatuschange","openApiOperationId":"eventCardsCardProductionStatusChange","summary":"Card production status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_781","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_781"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-production-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcardscardproductionstatuschange"}],"panels":[]}]},"httpPath":"cards#card-production-status-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCards3dsChallenge","name":"3DS challenge","isWebhook":true,"pointer":"/paths/cards#3ds-challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3DS challenge","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#3ds-challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#3ds-challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_779"}},"schemaId":"schema_779","pointer":"/paths/cards#3ds-challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#3ds-challenge","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_779"}},"responseCodes":["200"],"pointer":"cards#3ds-challenge","href":"webhook-event/eventcards3dschallenge","openApiOperationId":"eventCards3dsChallenge","summary":"3DS challenge"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_779","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_779"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#3ds-challenge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcards3dschallenge"}],"panels":[]}]},"httpPath":"cards#3ds-challenge"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsCardOrderStatusChange","name":"Card order status change","isWebhook":true,"pointer":"/paths/cards#card-order-status-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card order status change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#card-order-status-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available card order statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The initial card order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on the requirement fulfillment state. The possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order is created. The card will be generated once it has fulfilled all the requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIREMENTS_FULFILLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order has fulfilled all the requirements and the card should be generated in a short while."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_DETAILS_CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has been generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The physical card has been produced and is waiting to be picked up by delivery vendor (physical card only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has been activated and is ready to use. The card order is completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card order has been cancelled. This can happen if you contact Wise Support to cancel a card order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery failed. The physical card has been returned and will be blocked (physical card only)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/card-order-status-flow.5dc3cd6580ca9beb1217ee786ebbd65a439ee722e9168a86b2b47b440ed09060.28b10c14.png","alt":"Create card order statuses transition diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#card-order-status-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"schemaId":"schema_789","pointer":"/paths/cards#card-order-status-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#card-order-status-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_789"}},"responseCodes":["200"],"pointer":"cards#card-order-status-change","href":"webhook-event/eventcardscardorderstatuschange","openApiOperationId":"eventCardsCardOrderStatusChange","summary":"Card order status change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_789","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#card-order-status-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcardscardorderstatuschange"}],"panels":[]}]},"httpPath":"cards#card-order-status-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsTransactionStateChange","name":"Card transaction state change","isWebhook":true,"pointer":"/paths/cards#transaction-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card transaction state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered whenever a new card transaction occurs or is modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#transaction-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventcardstransactionstatechange/request/card-transaction/eventcardstransactionstatechange/request/transaction-categorisation","deepLinkHash":"/webhook-event/eventcardstransactionstatechange#webhook-event/eventcardstransactionstatechange/request/card-transaction/eventcardstransactionstatechange/request/transaction-categorisation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction categorisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions can be categorized based on the guidelines below, though the results may not always be consistent."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active card check: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0 or 1 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.category.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not equal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6011"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATM balance check: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.category.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6011"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Authorisation: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_amount_confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#transaction-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"schemaId":"schema_792","pointer":"/paths/cards#transaction-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#transaction-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_792"}},"responseCodes":["200"],"pointer":"cards#transaction-state-change","href":"webhook-event/eventcardstransactionstatechange","openApiOperationId":"eventCardsTransactionStateChange","summary":"Card transaction state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_792","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_792"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#transaction-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcardstransactionstatechange"}],"panels":[]}]},"httpPath":"cards#transaction-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventCardsManualProvisioningVerification","name":"Cards manual provisioning verification","isWebhook":true,"pointer":"/paths/cards#manual-provisioning-verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cards manual provisioning verification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a card is manually added to a wallet provider, and the verification methods required to complete the wallet provisioning are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cards#manual-provisioning-verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/cards#manual-provisioning-verification/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"schemaId":"components/schemas/v2.0.0-12","pointer":"/paths/cards#manual-provisioning-verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cards#manual-provisioning-verification","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"responseCodes":["200"],"pointer":"cards#manual-provisioning-verification","href":"webhook-event/eventcardsmanualprovisioningverification","openApiOperationId":"eventCardsManualProvisioningVerification","summary":"Cards manual provisioning verification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/v2.0.0-12","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v2.0.0-12"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/cards#manual-provisioning-verification/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventcardsmanualprovisioningverification"}],"panels":[]}]},"httpPath":"cards#manual-provisioning-verification"},{"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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventHoldLimitBreachUpdate","name":"Hold limit breach update","isWebhook":true,"pointer":"/paths/hold-limit-breach#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hold limit breach update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine whether the breach has been opened or closed, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.closing_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to understand how it was resolved."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hold-limit-breach#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/hold-limit-breach#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"],"pointer":"/paths/hold-limit-breach#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"hold-limit-breach#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"responseCodes":["200"],"pointer":"hold-limit-breach#update","href":"webhook-event/eventholdlimitbreachupdate","openApiOperationId":"eventHoldLimitBreachUpdate","summary":"Hold limit breach update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v4.0.0-12","exampleIds":["paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened","paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/hold-limit-breach#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventholdlimitbreachupdate"}],"panels":[]}]},"httpPath":"hold-limit-breach#update"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesCddCheckStateChange","name":"Additional verification state change","isWebhook":true,"pointer":"/paths/profiles#cdd-check-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Additional verification state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event pushes updates for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Customer Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" process."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#cdd-check-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/verification-state-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/verification-state-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification state values"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFIED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional verification check has passed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVIDENCE_REQUIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional verification check has failed, evidences are required ."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/review-outcome-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/review-outcome-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review outcome values"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_POOR_QUALITY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document quality poor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_OUT_OF_DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document out of date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_NAME_MISMATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name on document does not match records."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_NAME"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name on document missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_ISSUE_DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document issue date missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_COMPANY_LOGO_LETTERHEAD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company logo or letterhead missing from document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_NOT_COMPLETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document is partially cut-off and does not contain full information."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_SIGNATURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document missing signature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_MISSING_INCOME"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document missing income information or income is not clear from the document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOCUMENT_TYPE_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submitted document type is not acceptable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVOICE_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice is not an accepted document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_ID_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Photo ID is not an accepted document."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSACTION_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction (or a screenshot of a transaction) is not accepted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHOTO_UNACCEPTABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Photos (or computer screenshots) are not acceptable."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason unknown."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/required-evidence-values","deepLinkHash":"/webhook-event/eventprofilescddcheckstatechange#webhook-event/eventprofilescddcheckstatechange/request/verification/eventprofilescddcheckstatechange/request/required-evidence-values"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required evidence values"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of evidences"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find all possible values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#cdd-check-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"schemaId":"schema_703","pointer":"/paths/profiles#cdd-check-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#cdd-check-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_703"}},"responseCodes":["200"],"pointer":"profiles#cdd-check-state-change","href":"webhook-event/eventprofilescddcheckstatechange","openApiOperationId":"eventProfilesCddCheckStateChange","summary":"Additional verification state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_703","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#cdd-check-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventprofilescddcheckstatechange"}],"panels":[]}]},"httpPath":"profiles#cdd-check-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesOverdraftLimitThreshold","name":"Overdraft limit threshold","isWebhook":true,"pointer":"/paths/profiles#overdraft-limit-threshold/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Overdraft limit threshold","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the overdraft limit usage has reached 70% threshold. The event at each threshold is triggered maximum once per hour."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#overdraft-limit-threshold"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#overdraft-limit-threshold/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_679"}},"schemaId":"schema_679","pointer":"/paths/profiles#overdraft-limit-threshold/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#overdraft-limit-threshold","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_679"}},"responseCodes":["200"],"pointer":"profiles#overdraft-limit-threshold","href":"webhook-event/eventprofilesoverdraftlimitthreshold","openApiOperationId":"eventProfilesOverdraftLimitThreshold","summary":"Overdraft limit threshold"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_679","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_679"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#overdraft-limit-threshold/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventprofilesoverdraftlimitthreshold"}],"panels":[]}]},"httpPath":"profiles#overdraft-limit-threshold"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesStateChange","name":"Profile state change","isWebhook":true,"pointer":"/paths/profiles#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a profile's state is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"schemaId":"schema_680","pointer":"/paths/profiles#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_680"}},"responseCodes":["200"],"pointer":"profiles#state-change","href":"webhook-event/eventprofilesstatechange","openApiOperationId":"eventProfilesStateChange","summary":"Profile state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_680","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventprofilesstatechange"}],"panels":[]}]},"httpPath":"profiles#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventProfilesVerificationStateChange","name":"Verification state change","isWebhook":true,"pointer":"/paths/profiles#verification-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the verification state of a connected profile changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A profile's "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the user is ready to make payments using Wise."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then we advise not to initiate any transfers with the user's access token as the payments will not be processed until the verification is completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#verification-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/profiles#verification-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_681"}},"schemaId":"schema_681","pointer":"/paths/profiles#verification-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"profiles#verification-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_681"}},"responseCodes":["200"],"pointer":"profiles#verification-state-change","href":"webhook-event/eventprofilesverificationstatechange","openApiOperationId":"eventProfilesVerificationStateChange","summary":"Verification state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_681","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_681"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/profiles#verification-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventprofilesverificationstatechange"}],"panels":[]}]},"httpPath":"profiles#verification-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventKycReviewsStateChange","name":"KYC review state change","isWebhook":true,"pointer":"/paths/kyc-reviews#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KYC review state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a KYC review state has changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In previous versions, this event fired only when the overall KYC review state changed. In "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v5.0.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it fires on every requirement or additional requirement state change, which may result in receiving more events. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.prevState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.requirementChanges"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on what changed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kyc-reviews#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/kyc-reviews#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"schemaId":"schema_698","pointer":"/paths/kyc-reviews#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"kyc-reviews#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_698"}},"responseCodes":["200"],"pointer":"kyc-reviews#state-change","href":"webhook-event/eventkycreviewsstatechange","openApiOperationId":"eventKycReviewsStateChange","summary":"KYC review state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_698","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/kyc-reviews#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventkycreviewsstatechange"}],"panels":[]}]},"httpPath":"kyc-reviews#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventUsersStateChange","name":"User state change","isWebhook":true,"pointer":"/paths/users#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a user's state is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User state change transitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user's account is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITHDRAW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user has 90 calendar days to remove their money from their balance before we fully close their account. This can be done through sending from their balance to themselves and others or spending with their card. The user still cannot order new cards, convert between balances, open and close balances, and download balance statements. After 90 calendar days, the account moves into a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The user's account is deactivated and they cannot perform any actions on their account. The end-user tokens are revoked and you will receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for API calls."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/user-deactivation-flow.7df75a5ba10e3faef9629533e54c5d5bf332b6c3f0f622344408bf97a717b7b0.28b10c14.png","alt":"User state change flow diagram"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/users#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658","pointer":"/paths/users#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"users#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_658"}},"responseCodes":["200"],"pointer":"users#state-change","href":"webhook-event/eventusersstatechange","openApiOperationId":"eventUsersStateChange","summary":"User state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_658"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/users#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventusersstatechange"}],"panels":[]}]},"httpPath":"users#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBalancesUpdate","name":"Balance update","isWebhook":true,"pointer":"/paths/balances#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a multi-currency account is credited or debited."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.step_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to order events within a single transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For tracking events related to a single transaction such as a cancelled card transaction, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.step_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/balances#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_740"}},"schemaId":"schema_740","pointer":"/paths/balances#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"balances#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_740"}},"responseCodes":["200"],"pointer":"balances#update","href":"webhook-event/eventbalancesupdate","openApiOperationId":"eventBalancesUpdate","summary":"Balance update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_740","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_740"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/balances#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventbalancesupdate"}],"panels":[]}]},"httpPath":"balances#update"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBalancesAccountStateChange","name":"Balance account state change","isWebhook":true,"pointer":"/paths/balances#account-state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance account state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a balance account is activated or deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#account-state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/balances#account-state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_741"}},"schemaId":"schema_741","pointer":"/paths/balances#account-state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"balances#account-state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_741"}},"responseCodes":["200"],"pointer":"balances#account-state-change","href":"webhook-event/eventbalancesaccountstatechange","openApiOperationId":"eventBalancesAccountStateChange","summary":"Balance account state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_741","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_741"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/balances#account-state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventbalancesaccountstatechange"}],"panels":[]}]},"httpPath":"balances#account-state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBatchPaymentInitiationsStateChange","name":"Batch payment initiations state change","isWebhook":true,"pointer":"/paths/batch-payment-initiations#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch payment initiations state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when the payment initiation state of a batch group payment changes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expected state of a batch payment initiation can be one of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGED_BACK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch-payment-initiations#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/batch-payment-initiations#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_876"}},"schemaId":"schema_876","pointer":"/paths/batch-payment-initiations#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"batch-payment-initiations#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_876"}},"responseCodes":["200"],"pointer":"batch-payment-initiations#state-change","href":"webhook-event/eventbatchpaymentinitiationsstatechange","openApiOperationId":"eventBatchPaymentInitiationsStateChange","summary":"Batch payment initiations state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_876","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_876"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/batch-payment-initiations#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventbatchpaymentinitiationsstatechange"}],"panels":[]}]},"httpPath":"batch-payment-initiations#state-change"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventPartnerSupportCaseChanged","name":"Partner support case changed","isWebhook":true,"pointer":"/paths/partner-support#case-changed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partner support case changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a case is created or updated, including when a new message is added or the status changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you will also receive a webhook response when you have updated a case."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner-support#case-changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. To reconcile order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema versions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/partner-support#case-changed/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"schemaId":"schema_888","pointer":"/paths/partner-support#case-changed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"partner-support#case-changed","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_888"}},"responseCodes":["200"],"pointer":"partner-support#case-changed","href":"webhook-event/eventpartnersupportcasechanged","openApiOperationId":"eventPartnerSupportCaseChanged","summary":"Partner support case changed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_888","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/partner-support#case-changed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventpartnersupportcasechanged"}],"panels":[]}]},"httpPath":"partner-support#case-changed"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventSwiftInCredit","name":"Swift receive credit","isWebhook":true,"pointer":"/paths/swift-in#credit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Swift receive credit","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a SWIFT message is received and a credit is deposited into a balance account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you also subscribe to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balances#credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same profile or application, you may experience some duplication of webhook events. You should make allowances for this to handle it in your implementation."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift-in#credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/swift-in#credit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"schemaId":"schema_889","pointer":"/paths/swift-in#credit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"swift-in#credit","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_889"}},"responseCodes":["200"],"pointer":"swift-in#credit","href":"webhook-event/eventswiftincredit","openApiOperationId":"eventSwiftInCredit","summary":"Swift receive credit"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_889","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_889"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/swift-in#credit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventswiftincredit"}],"panels":[]}]},"httpPath":"swift-in#credit"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventSwiftMessageReceived","name":"Swift message received","isWebhook":true,"pointer":"/paths/swift#message-received/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Swift message received","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a SWIFT message (e.g., "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/receive-money/incoming-transfer-notifications#example-pacs008-message-content"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pacs.008"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is received and processed by Wise on behalf of a partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift#message-received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/swift#message-received/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"schemaId":"schema_890","pointer":"/paths/swift#message-received/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"swift#message-received","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_890"}},"responseCodes":["200"],"pointer":"swift#message-received","href":"webhook-event/eventswiftmessagereceived","openApiOperationId":"eventSwiftMessageReceived","summary":"Swift message received"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_890","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_890"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/swift#message-received/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventswiftmessagereceived"}],"panels":[]}]},"httpPath":"swift#message-received"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventTransactionDisputesUpdate","name":"Transaction disputes update","isWebhook":true,"pointer":"/paths/transaction-disputes#update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction disputes update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a transaction dispute is submitted or updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may receive update events even when there are no apparent changes in the dispute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", as certain underlying modifications might not directly impact these visible indicators."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction-disputes#update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/transaction-disputes#update/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"schemaId":"schema_826","pointer":"/paths/transaction-disputes#update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transaction-disputes#update","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_826"}},"responseCodes":["200"],"pointer":"transaction-disputes#update","href":"webhook-event/eventtransactiondisputesupdate","openApiOperationId":"eventTransactionDisputesUpdate","summary":"Transaction disputes update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_826","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_826"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/transaction-disputes#update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventtransactiondisputesupdate"}],"panels":[]}]},"httpPath":"transaction-disputes#update"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventBulkSettlementPaymentReceived","name":"Bulk settlement payment received","isWebhook":true,"pointer":"/paths/bulk-settlement#payment-received/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk settlement payment received","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_matched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If it is not matched, check the difference between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine how much more needs to be paid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This event can also be triggered when our operations team reallocates funds between settlements. Therefore, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"received_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in version 2.0.0 of the webhook is inaccurate. Please use the latest version, 4.0.0. Version 2.0.0 is deprecated."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk-settlement#payment-received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/bulk-settlement#payment-received/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_882"}},"schemaId":"schema_882","pointer":"/paths/bulk-settlement#payment-received/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"bulk-settlement#payment-received","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_882"}},"responseCodes":["200"],"pointer":"bulk-settlement#payment-received","href":"webhook-event/eventbulksettlementpaymentreceived","openApiOperationId":"eventBulkSettlementPaymentReceived","summary":"Bulk settlement payment received"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_882","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_882"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/bulk-settlement#payment-received/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventbulksettlementpaymentreceived"}],"panels":[]}]},"httpPath":"bulk-settlement#payment-received"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventIncomingTransferCredited","name":"Incoming transfer credited","isWebhook":true,"pointer":"/paths/incoming-transfer#credited/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming transfer credited","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when an incoming transfer is credited to a Wise balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a thin event, containing just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming_transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Fetch the full resource via the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/incoming-transfer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incoming transfer endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming-transfer#credited"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/incoming-transfer#credited/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"schemaId":"schema_764","pointer":"/paths/incoming-transfer#credited/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"incoming-transfer#credited","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_764"}},"responseCodes":["200"],"pointer":"incoming-transfer#credited","href":"webhook-event/eventincomingtransfercredited","openApiOperationId":"eventIncomingTransferCredited","summary":"Incoming transfer credited"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_764","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event. Returning other statuses will not change the incoming transfer's state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/incoming-transfer#credited/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventincomingtransfercredited"}],"panels":[]}]},"httpPath":"incoming-transfer#credited"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventRecipientsStateChange","name":"Recipient state change","isWebhook":true,"pointer":"/paths/recipients#state-change/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipient state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a recipient account created or changed through hosted recipient creation changes state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows#hosted-recipient-creation-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an example recipient creation flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.occurred_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reconcile the order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Ordering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipients#state-change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/recipients#state-change/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_846"}},"schemaId":"schema_846","pointer":"/paths/recipients#state-change/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"recipients#state-change","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_846"}},"responseCodes":["200"],"pointer":"recipients#state-change","href":"webhook-event/eventrecipientsstatechange","openApiOperationId":"eventRecipientsStateChange","summary":"Recipient state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_846","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_846"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/recipients#state-change/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-event/eventrecipientsstatechange"}],"panels":[]}]},"httpPath":"recipients#state-change"}],"content":{"contentType":"group","meta":{"name":"webhook-event"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook events are notifications Wise sends to your server when specific actions occur. Subscribe to events using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints at the application or profile level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"transfers#active-cases","summary":"Transfer active cases","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventtransfersactivecases","deprecated":false},{"title":"transfers#refund","summary":"Transfer refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventtransfersrefund","deprecated":false},{"title":"transfers#payout-failure","summary":"Transfer payout failure","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventtransferspayoutfailure","deprecated":false},{"title":"transfers#state-change","summary":"Transfer state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventtransfersstatechange","deprecated":false},{"title":"account-details-order#order-state-change","summary":"Account details order state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventaccountdetailsorderstatechange","deprecated":false},{"title":"account-details-payment#state-change","summary":"Account details payment state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventaccountdetailspaymentstatechange","deprecated":false},{"title":"cards#card-status-change","summary":"Card status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcardscardstatuschange","deprecated":false},{"title":"cards#card-production-status-change","summary":"Card production status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcardscardproductionstatuschange","deprecated":false},{"title":"cards#3ds-challenge","summary":"3DS challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcards3dschallenge","deprecated":false},{"title":"cards#card-order-status-change","summary":"Card order status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcardscardorderstatuschange","deprecated":false},{"title":"cards#transaction-state-change","summary":"Card transaction state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcardstransactionstatechange","deprecated":false},{"title":"cards#manual-provisioning-verification","summary":"Cards manual provisioning verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventcardsmanualprovisioningverification","deprecated":false},{"title":"hold-limit-breach#update","summary":"Hold limit breach update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventholdlimitbreachupdate","deprecated":false},{"title":"profiles#cdd-check-state-change","summary":"Additional verification state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventprofilescddcheckstatechange","deprecated":false},{"title":"profiles#overdraft-limit-threshold","summary":"Overdraft limit threshold","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventprofilesoverdraftlimitthreshold","deprecated":false},{"title":"profiles#state-change","summary":"Profile state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventprofilesstatechange","deprecated":false},{"title":"profiles#verification-state-change","summary":"Verification state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventprofilesverificationstatechange","deprecated":false},{"title":"kyc-reviews#state-change","summary":"KYC review state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventkycreviewsstatechange","deprecated":false},{"title":"users#state-change","summary":"User state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventusersstatechange","deprecated":false},{"title":"balances#update","summary":"Balance update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventbalancesupdate","deprecated":false},{"title":"balances#account-state-change","summary":"Balance account state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventbalancesaccountstatechange","deprecated":false},{"title":"batch-payment-initiations#state-change","summary":"Batch payment initiations state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventbatchpaymentinitiationsstatechange","deprecated":false},{"title":"partner-support#case-changed","summary":"Partner support case changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventpartnersupportcasechanged","deprecated":false},{"title":"swift-in#credit","summary":"Swift receive credit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventswiftincredit","deprecated":false},{"title":"swift#message-received","summary":"Swift message received","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventswiftmessagereceived","deprecated":false},{"title":"transaction-disputes#update","summary":"Transaction disputes update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventtransactiondisputesupdate","deprecated":false},{"title":"bulk-settlement#payment-received","summary":"Bulk settlement payment received","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventbulksettlementpaymentreceived","deprecated":false},{"title":"incoming-transfer#credited","summary":"Incoming transfer credited","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventincomingtransfercredited","deprecated":false},{"title":"recipients#state-change","summary":"Recipient state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-event/eventrecipientsstatechange","deprecated":false}]}]}]}]}},{"type":"separator","label":"Simulations","content":null},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationTransferStateChange","name":"Simulate transfer state change","isWebhook":false,"pointer":"/paths/~1simulation~1transfers~1{transferId}~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate transfer state change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes the transfer status to the specified state. The available state transitions are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incoming_payment_waiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_converted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Refer to regional guides for special regional requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_converted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced_back"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outgoing_payment_sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced_back"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulation is not supported for email transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fund the transfer first before calling any simulation endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Even if funding moves the transfer to a processing state, you must still call the /processing simulation endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Although the simulation request may respond immediately, processing is asynchronous - wait at least 5 seconds between simulation calls."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"simulation/simulationtransferstatechange/request/sandbox-refund","deepLinkHash":"/simulation/simulationtransferstatechange#simulation/simulationtransferstatechange/request/sandbox-refund"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox refund simulation behaviour "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When simulating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_refunded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers#refund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook is delivered with a simulated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The amount is calculated as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT payouts:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A random fee between 5-15% is deducted from the source amount. This is non-deterministic — each simulation produces a different refund amount. This is intended for testing your partial refund handling flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-SWIFT payouts:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The full source amount is refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The simulated refund amount only applies to the webhook payload. Balances and the sandbox UI will always reflect the full refund amount regardless of payout method, so the webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refund_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may differ from what is shown in balances and the sandbox UI for SWIFT transfers."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This simulation is not suitable for reconciliation testing between webhook amounts and balances."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The ID of the transfer to simulate.","required":true},{"name":"status","in":"path","schemaId":"schema_891","description":"The target transfer status.","required":true}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1{status}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/simulation/transfers/{transferId}/{status}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"},{"name":"status","in":"path","required":true,"schemaId":"schema_891"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/simulation/transfers/{transferId}/{status}","href":"simulation/simulationtransferstatechange","openApiOperationId":"simulationTransferStateChange","summary":"Simulate transfer state change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer with updated status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationtransferstatechange"}],"panels":[]}]},"httpPath":"/simulation/transfers/{transferId}/{status}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationTransferPayoutFailure","name":"Simulate transfer payout failure","isWebhook":false,"pointer":"/paths/~1simulation~1transfers~1{transferId}~1payout-failure/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate transfer payout failure","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggers transfers#payout-failure webhook for the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available payout failure reason codes are listed in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfers#payout-failure webhook guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulation requires transfer to be in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced_back"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While payout failure simulation call will respond with 200 in real time, the payout failure webhook is asynchronous."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body is optional; omit it or send {} to trigger a random failure reason."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transferId","in":"path","schemaId":"schema_650","description":"The ID of the transfer to simulate.","required":true}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_892","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"]}},"schemaId":"schema_892","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/transfers/{transferId}/payout-failure","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"transferId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_892","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"]}},"responseCodes":["200","400","429","500"],"pointer":"/simulation/transfers/{transferId}/payout-failure","href":"simulation/simulationtransferpayoutfailure","openApiOperationId":"simulationTransferPayoutFailure","summary":"Simulate transfer payout failure"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_892","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_892","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful initiation of payout failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request - invalid input or transfer state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState"]}},"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"}],"pointer":"/paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode","paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"500","schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626","exampleIds":["paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationtransferpayoutfailure"}],"panels":[]}]},"httpPath":"/simulation/transfers/{transferId}/payout-failure"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationVerification","name":"Simulate verification for a profile","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1verifications/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate verification for a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes a specific profile's verification state to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful for testing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#verification-state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook and is a prerequisite for setting up a Multi-Currency Account (MCA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts both user and application API tokens."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The ID of the profile to verify.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1verifications/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/verifications","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/simulation/profiles/{profileId}/verifications","href":"simulation/simulationverification","openApiOperationId":"simulationVerification","summary":"Simulate verification for a profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification state changed successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationverification"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/verifications"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationVerifyProfile","name":"Simulate verification for all profiles","isWebhook":false,"pointer":"/paths/~1simulation~1verify-profile/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate verification for all profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies all profiles associated with the authenticated user, changing their verification state to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful for testing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profiles#verification-state-change"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook and is a prerequisite for setting up a Multi-Currency Account (MCA)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepts user API tokens only. The profiles are identified via the token."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1verify-profile/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/verify-profile","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/simulation/verify-profile","href":"simulation/simulationverifyprofile","openApiOperationId":"simulationVerifyProfile","summary":"Simulate verification for all profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification state changed successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1verify-profile/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationverifyprofile"}],"panels":[]}]},"httpPath":"/simulation/verify-profile"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationBalanceTopup","name":"Simulate a balance top-up","isWebhook":false,"pointer":"/paths/~1simulation~1balance~1topup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate a balance top-up","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Simulates a top-up so that a balance can be used to fund transfers and/or card spend.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1balance~1topup/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_893","exampleIds":["paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1balance~1topup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/balance/topup","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/simulation/balance/topup","href":"simulation/simulationbalancetopup","openApiOperationId":"simulationBalanceTopup","summary":"Simulate a balance top-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_893","exampleIds":["paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_893","exampleIds":["paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Simulated balance top-up result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894","exampleIds":["paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_894","exampleIds":["paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1balance~1topup/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_894","exampleIds":["paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_894","exampleIds":["paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationbalancetopup"}],"panels":[]}]},"httpPath":"/simulation/balance/topup"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationCardTransactionAuthorisation","name":"Simulate a card transaction authorisation","isWebhook":false,"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate a card transaction authorisation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the 16-digit Primary Account Number (PAN) of the card, and must be a valid PAN retrieved from sensitive card details. Please follow the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detailed guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on retrieving sensitive card details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"simulation/simulationcardtransactionauthorisation/request/refund","deepLinkHash":"/simulation/simulationcardtransactionauthorisation#simulation/simulationcardtransactionauthorisation/request/refund"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A refund is a 2-step process: first authorise with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then clear using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationcardtransactionclearing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clearing endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same transaction type."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund simulation doesn't work with Mastercard."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_895","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"]}},"schemaId":"schema_895","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_895","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"]}},"responseCodes":["200","429"],"pointer":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation","href":"simulation/simulationcardtransactionauthorisation","openApiOperationId":"simulationCardTransactionAuthorisation","summary":"Simulate a card transaction authorisation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_895","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_895","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal","paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Simulated card authorisation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_896","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_896","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_896","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationcardtransactionauthorisation"}],"panels":[]}]},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationCardTransactionClearing","name":"Simulate a card transaction clearing","isWebhook":false,"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate a card transaction clearing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates a transaction clearing request in the sandbox environment. This is done after the authorisation. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field can be copied from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object in the authorisation response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clear a previous authorisation, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details must match the previous authorisation request. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have to match the previous authorisation request, it can be more or less than the authorisation request amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clearing simulation doesn't work with Mastercard."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"simulation/simulationcardtransactionclearing/request/refund","deepLinkHash":"/simulation/simulationcardtransactionclearing#simulation/simulationcardtransactionclearing/request/refund"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A refund is a 2-step process: first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/simulation/simulationcardtransactionauthorisation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then clear using this endpoint with the same transaction type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_897","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing","href":"simulation/simulationcardtransactionclearing","openApiOperationId":"simulationCardTransactionClearing","summary":"Simulate a card transaction clearing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_897","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_897","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Simulated transaction clearing result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationcardtransactionclearing"}],"panels":[]}]},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationCardTransactionReversal","name":"Simulate a card transaction reversal","isWebhook":false,"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate a card transaction reversal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates a transaction reversal request in the sandbox environment. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a transaction value was originally 10 SGD, and the intended final value is 3 SGD, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be set to 3. This means there is a partial refund of 7 SGD."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_899","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_899","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_899","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal","href":"simulation/simulationcardtransactionreversal","openApiOperationId":"simulationCardTransactionReversal","summary":"Simulate a card transaction reversal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_899","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_899","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Simulated transaction reversal result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_898","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationcardtransactionreversal"}],"panels":[]}]},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationCardTransactions","name":"List simulated card transactions","isWebhook":false,"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List simulated card transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of simulated card transactions, in descending order of creation time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve more details of a transaction, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction/cardtransactionget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get card transaction by ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_900","description":"The maximum number of transactions to return. The default value is 10."}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_647"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_900"}],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","429"],"pointer":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions","href":"simulation/simulationcardtransactions","openApiOperationId":"simulationCardTransactions","summary":"List simulated card transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of simulated card transactions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_901","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_901","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_901","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationcardtransactions"}],"panels":[]}]},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationCardProduction","name":"Simulate card production state change","isWebhook":false,"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate card production state change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates a card production status change in the sandbox environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure that you have created a physical card order with KIOSK_COLLECTION delivery method and that you produce the card before calling this endpoint to simulate various card production statuses."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"cardToken","in":"path","schemaId":"schema_647","description":"The card token.","required":true}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_902","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_902","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/production","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"cardToken","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_902","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","429"],"pointer":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/production","href":"simulation/simulationcardproduction","openApiOperationId":"simulationCardProduction","summary":"Simulate card production state change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_902","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_902","exampleIds":["paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Card production state changed successfully.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationcardproduction"}],"panels":[]}]},"httpPath":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/production"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationKycReviewRequirementsList","name":"List KYC review requirements","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List KYC review requirements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all blocking requirements for a KYC (Know Your Customer) review. These outstanding KYC requirements typically act as \"blocking requirements\", preventing actions like creating transfers.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The ID of the existing KYC review.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","429"],"pointer":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements","href":"simulation/simulationkycreviewrequirementslist","openApiOperationId":"simulationKycReviewRequirementsList","summary":"List KYC review requirements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of KYC review requirements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_903","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_903","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"KYC review not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_903","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_903","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationkycreviewrequirementslist"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationKycReviewRequirementsAdd","name":"Simulate adding new requirement","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate adding new requirement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new requirement for a KYC (Know Your Customer) review for a business profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can only be used for business profiles. It creates a static "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_USE_CASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requirement only."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID requiring the new requirement to be added.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The ID of the existing KYC review.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_904"}},"schemaId":"schema_904","pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_904"}},"responseCodes":["202","400","429"],"pointer":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add","href":"simulation/simulationkycreviewrequirementsadd","openApiOperationId":"simulationKycReviewRequirementsAdd","summary":"Simulate adding new requirement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_904","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_904"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Requirement added successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationkycreviewrequirementsadd"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationKycReviewRequirementsSubmit","name":"Simulate requirement submission","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate requirement submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates providing everything needed for a particular KYC requirement. This can be used in place of going through a hosted journey on the browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This functionality only works for the following requirements: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_PURPOSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID_DOCUMENT_WITH_LIVENESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SOURCE_OF_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and any other that has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"___"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delimiter in them."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The ID of the existing KYC review.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_905","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_905","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_905","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","429"],"pointer":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit","href":"simulation/simulationkycreviewrequirementssubmit","openApiOperationId":"simulationKycReviewRequirementsSubmit","summary":"Simulate requirement submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_905","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_905","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Requirement submitted successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationkycreviewrequirementssubmit"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationKycReviewVerify","name":"Simulate verifying a KYC review","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate verifying a KYC review","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verifies requirement(s) on an existing KYC (Know Your Customer) review. Can be used after a user has provided input for a requirement through the hosted journey or simulated the requirement submission.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true},{"name":"kycReviewId","in":"path","schemaId":"schema_647","description":"The ID of the existing KYC review.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_906","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_906","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"},{"name":"kycReviewId","in":"path","required":true,"schemaId":"schema_647"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_906","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","429"],"pointer":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify","href":"simulation/simulationkycreviewverify","openApiOperationId":"simulationKycReviewVerify","summary":"Simulate verifying a KYC review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_906","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_906","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"KYC review verified successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationkycreviewverify"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationBankTransactionImport","name":"Simulate incoming bank transfer","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate incoming bank transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/bank-account-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Account Details API reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on setting up bank details to receive money."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This functionality only works for the following currencies: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GBP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns a 400 error when account details for the specified currency do not exist."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bank-transaction-import-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest","paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"]}},"schemaId":"components/schemas/bank-transaction-import-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest","paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/bank-transactions/import","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bank-transaction-import-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest","paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"]}},"responseCodes":["201","400","429"],"pointer":"/simulation/profiles/{profileId}/bank-transactions/import","href":"simulation/simulationbanktransactionimport","openApiOperationId":"simulationBankTransactionImport","summary":"Simulate incoming bank transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/bank-transaction-import-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest","paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bank-transaction-import-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest","paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Bank transaction imported successfully. No content returned.","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationbanktransactionimport"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/bank-transactions/import"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"simulationSwiftIn","name":"Simulate incoming Swift payment","isWebhook":false,"pointer":"/paths/~1simulation~1profiles~1{profileId}~1swift-in/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate incoming Swift payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request is successful the transfer is logged in our back office, which triggers a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event/eventswiftincredit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"swift-in#credit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event and results in a balance update."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While most fields are optional, default values will be provided as needed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_650","description":"The profile ID.","required":true}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1swift-in/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1swift-in/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/swift-in-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal","paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"]}},"schemaId":"components/schemas/swift-in-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal","paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulation/profiles/{profileId}/swift-in","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/swift-in-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal","paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"]}},"responseCodes":["200","400","422","429"],"pointer":"/simulation/profiles/{profileId}/swift-in","href":"simulation/simulationswiftin","openApiOperationId":"simulationSwiftIn","summary":"Simulate incoming Swift payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/swift-in-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal","paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/swift-in-request","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal","paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Swift payment simulated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"Unprocessable Entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example"]}},"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example"]}}},{"code":"400","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example"]}}},{"code":"422","exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulation/simulationswiftin"}],"panels":[]}]},"httpPath":"/simulation/profiles/{profileId}/swift-in"}],"content":{"contentType":"group","meta":{"name":"simulation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to simulate key actions in the sandbox environment, including transfer state changes, balance top-ups, card transactions, KYC reviews, and incoming payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These features are limited to sandbox only."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/simulation/transfers/{transferId}/{status}","summary":"Simulate transfer state change","prefix":{"name":"get","color":"get"},"badges":[],"link":"/simulation/simulationtransferstatechange","deprecated":false},{"title":"/simulation/transfers/{transferId}/payout-failure","summary":"Simulate transfer payout failure","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationtransferpayoutfailure","deprecated":false},{"title":"/simulation/profiles/{profileId}/verifications","summary":"Simulate verification for a profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationverification","deprecated":false},{"title":"/simulation/verify-profile","summary":"Simulate verification for all profiles","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationverifyprofile","deprecated":false},{"title":"/simulation/balance/topup","summary":"Simulate a balance top-up","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationbalancetopup","deprecated":false},{"title":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/authorisation","summary":"Simulate a card transaction authorisation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationcardtransactionauthorisation","deprecated":false},{"title":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/clearing","summary":"Simulate a card transaction clearing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationcardtransactionclearing","deprecated":false},{"title":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions/reversal","summary":"Simulate a card transaction reversal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationcardtransactionreversal","deprecated":false},{"title":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/transactions","summary":"List simulated card transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/simulation/simulationcardtransactions","deprecated":false},{"title":"/simulation/spend/profiles/{profileId}/cards/{cardToken}/production","summary":"Simulate card production state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationcardproduction","deprecated":false},{"title":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements","summary":"List KYC review requirements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/simulation/simulationkycreviewrequirementslist","deprecated":false},{"title":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/add","summary":"Simulate adding new requirement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationkycreviewrequirementsadd","deprecated":false},{"title":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit","summary":"Simulate requirement submission","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationkycreviewrequirementssubmit","deprecated":false},{"title":"/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/verify","summary":"Simulate verifying a KYC review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationkycreviewverify","deprecated":false},{"title":"/simulation/profiles/{profileId}/bank-transactions/import","summary":"Simulate incoming bank transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationbanktransactionimport","deprecated":false},{"title":"/simulation/profiles/{profileId}/swift-in","summary":"Simulate incoming Swift payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulation/simulationswiftin","deprecated":false}]}]}]}]}},{"type":"separator","label":"Partner Support","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"caseCreate","name":"Create a case","isWebhook":false,"pointer":"/paths/~1cases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cases are used to collect or transmit additional information between Partners and Wise. Use this endpoint to create a new case."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please do not include PII in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a case. Any specific details regarding the case that need to be communicated should be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1cases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_907"}},"schemaId":"schema_907","pointer":"/paths/~1cases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cases","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_907"}},"responseCodes":["200","429"],"pointer":"/cases","href":"case/casecreate","openApiOperationId":"caseCreate","summary":"Create a case"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_907","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_907"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created case.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/case"}},"schemaId":"components/schemas/case","headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1cases/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/case","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/case"}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case/casecreate"}],"panels":[]}]},"httpPath":"/cases"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"caseGet","name":"Retrieve a case by ID","isWebhook":false,"pointer":"/paths/~1cases~1{caseId}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a case by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the complete details of a support case including all public messages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and reference information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"case/caseget/request/response","deepLinkHash":"/case/caseget#case/caseget/request/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full case object with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case metadata (id, type, subType, status, timestamps)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile and external reference information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All public messages associated with the case"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages in the response can have three different content structures:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attributes Content (REQUEST messages)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present in messages like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOSIT_SANCTION_HIT_REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFERENCE_SANCTION_HIT_REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains dynamic attributes that define what information is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission Data Content (SUBMISSION messages)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present in messages like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOSIT_SANCTION_HIT_SUBMISSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFERENCE_LOCATION_HIT_SUBMISSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the data submitted by the partner in response to a request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text Content (FREEFORM messages)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREEFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" messages. Contains free text conversation between partners and Wise."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_650","description":"The unique identifier of the case.","required":true,"example":12345678}],"pointer":"/paths/~1cases~1{caseId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1cases~1{caseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cases/{caseId}","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429"],"pointer":"/cases/{caseId}","href":"case/caseget","openApiOperationId":"caseGet","summary":"Retrieve a case by ID"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X GET \\\n 'https://api.sandbox.wise.com/2026Q3/cases/{caseId}' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: Bearer '\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Case details retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/case-2","exampleIds":["paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney"]}},"schemaId":"components/schemas/case-2","exampleIds":["paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request - invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Unauthorized - missing or invalid authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Not found - the requested resource does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1cases~1{caseId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/case-2","exampleIds":["paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/case-2","exampleIds":["paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney","paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney"]}}},{"code":"400","schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case/caseget"}],"panels":[]}]},"httpPath":"/cases/{caseId}"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"caseSubmitMessage","name":"Submit a message to a case","isWebhook":false,"pointer":"/paths/~1cases~1{caseId}~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a message to a case","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a new message to an existing support case. The message type determines"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the expected structure of the submission data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/partner/submission-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case submission type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for details on each submission type along with an example.."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_650","description":"The unique identifier of the case.","required":true,"example":12345678}],"pointer":"/paths/~1cases~1{caseId}~1messages/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1cases~1{caseId}~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/message-submission-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"]}},"schemaId":"components/schemas/message-submission-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"],"pointer":"/paths/~1cases~1{caseId}~1messages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cases/{caseId}/messages","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"example":12345678,"schemaId":"schema_650"}],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/message-submission-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"]}},"responseCodes":["201","400","401","403","404","422","429"],"pointer":"/cases/{caseId}/messages","href":"case/casesubmitmessage","openApiOperationId":"caseSubmitMessage","summary":"Submit a message to a case"},"definitionSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \"https://api.wise.com/2026Q3/cases/12345678/messages\" \\\n -H \"Authorization: Bearer YOUR_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"FREEFORM\",\n \"submissionData\": {\n \"freeText\": \"Following up on the requested documentation. We have verified the recipient identity through our internal KYC process. The beneficial owner structure has been confirmed with no exposure to sanctioned entities. Please find attached (via secure upload) the supporting documentation including: 1) Company registration certificate, 2) Director identification, 3) Source of funds declaration.\"\n }\n }'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/message-submission-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/message-submission-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Message submitted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message-submission-response","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse","paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse"]}},"schemaId":"components/schemas/message-submission-response","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse","paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"400","description":"Bad request - invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"401","description":"Unauthorized - missing or invalid authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"404","description":"Not found - the requested resource does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"422","description":"Unprocessable Entity Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-422-unprocessable-entity","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/error-422-unprocessable-entity","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1cases~1{caseId}~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/message-submission-response","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse","paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message-submission-response","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse","paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse"]}}},{"code":"400","schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-400-bad-request","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-401-unauthorized","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-403-forbidden","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-404-not-found","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error-422-unprocessable-entity","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-422-unprocessable-entity","exampleIds":["paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case/casesubmitmessage"}],"panels":[]}]},"httpPath":"/cases/{caseId}/messages"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eventPartnerSupportCaseChanged","name":"Partner support case changed","isWebhook":true,"pointer":"/paths/partner-support#case-changed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partner support case changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered every time a case is created or updated, including when a new message is added or the status changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that you will also receive a webhook response when you have updated a case."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner-support#case-changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile level subscriptions: Not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application level subscriptions: Supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events may not be delivered in the order they occurred. To reconcile order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema version "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.resource.updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema versions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2.0.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.occurred_at"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-ordering"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ordering guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for setup instructions, signature verification, and best practices."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Signature-SHA256","in":"header","schemaId":"schema_639","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/webhooks/event-handling#requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise public key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure the request is authentic and has not been tampered with."},"children":[]}]}]}],"example":"t7FMhk3OARMgwqz0LJXO..."},{"name":"X-Delivery-Id","in":"header","schemaId":"schema_647","description":"Unique identifier for this webhook delivery attempt.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},{"name":"X-Test-Notification","in":"header","schemaId":"schema_657","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present with the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is a test notification sent to verify your callback URL during subscription setup."},"children":[]}]}]}],"example":true}],"pointer":"/paths/partner-support#case-changed/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"schemaId":"schema_888","pointer":"/paths/partner-support#case-changed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"partner-support#case-changed","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Signature-SHA256","in":"header","required":false,"example":"t7FMhk3OARMgwqz0LJXO...","schemaId":"schema_639"},{"name":"X-Delivery-Id","in":"header","required":false,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_647"},{"name":"X-Test-Notification","in":"header","required":false,"example":true,"schemaId":"schema_657"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_888"}},"responseCodes":["200"],"pointer":"partner-support#case-changed","href":"case/eventpartnersupportcasechanged","openApiOperationId":"eventPartnerSupportCaseChanged","summary":"Partner support case changed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"schema_888","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_888"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to acknowledge receipt of the event."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659"}],"pointer":"/paths/partner-support#case-changed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_659"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/case/eventpartnersupportcasechanged"}],"panels":[]}]},"httpPath":"partner-support#case-changed"}],"content":{"contentType":"group","meta":{"name":"case"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cases","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cases enable you to open, retrieve, and respond to support and operations queries through direct API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Partner Support API allows you to integrate your back-end tooling, enabling:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Faster responses through automated workflows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structured data via typed messages and submissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational efficiencies with programmatic case management"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case statuses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cases can move through different statuses."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner Action"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATING"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case being created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case being actioned"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No action needed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_CUSTOMER_INPUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOLVED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case solved and closed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact support"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"img","attributes":{"src":"/assets/case-status-flow-v2.82cd727b66d36e5a5efe97dcc1c5ac822b373c17fe7bf72f2f3bd66242cad056.28b10c14.svg"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages are typed and structured:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request messages:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOSIT_SANCTION_HIT_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECIPIENT_SANCTION_HIT_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFERENCE_SANCTION_HIT_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECIPIENT_LOCATION_HIT_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFERENCE_LOCATION_HIT_REQUEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREEFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Free text communication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission messages (from partner):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*_SUBMISSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Structured response to requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREEFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Free text communication"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cases","summary":"Create a case","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case/casecreate","deprecated":false},{"title":"/cases/{caseId}","summary":"Retrieve a case by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/case/caseget","deprecated":false},{"title":"/cases/{caseId}/messages","summary":"Submit a message to a case","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case/casesubmitmessage","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"partner-support#case-changed","summary":"Partner support case changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/case/eventpartnersupportcasechanged","deprecated":false}]}]}]}]}},{"type":"separator","label":"Tracking","content":null},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LookupGpiTracking","name":"Look up GPI tracking","isWebhook":false,"pointer":"/paths/~1gpi-tracking/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Look up GPI tracking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks up GPI tracking data for a transfer identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-External-Correlation-Id","in":"header","schemaId":"schema_621","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}],"pointer":"/paths/~1gpi-tracking/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LookupGpiTrackingRequestContent","exampleIds":["paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id","paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"]}},"schemaId":"components/schemas/LookupGpiTrackingRequestContent","exampleIds":["paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id","paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"],"pointer":"/paths/~1gpi-tracking/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gpi-tracking","servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-External-Correlation-Id","in":"header","required":false,"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","schemaId":"schema_621"}],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LookupGpiTrackingRequestContent","exampleIds":["paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id","paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"]}},"responseCodes":["200","429"],"pointer":"/gpi-tracking","href":"gpi-tracking/lookupgpitracking","openApiOperationId":"LookupGpiTracking","summary":"Look up GPI tracking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}],"schemaId":"components/schemas/LookupGpiTrackingRequestContent","exampleIds":["paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id","paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LookupGpiTrackingRequestContent","exampleIds":["paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id","paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns matching GPI tracking transactions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LookupGpiTrackingResponseContent","exampleIds":["paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found"]}},"schemaId":"components/schemas/LookupGpiTrackingResponseContent","exampleIds":["paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found"],"headers":{"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_623"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit exceeded. Retry after the number of seconds specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":5},"X-Rate-Limited-By":{"description":"Identifies the rate limiter that triggered the 429 response.","schema":{"type":"string"},"example":"wise-public-api"},"X-External-Correlation-Id":{"$ref":"#/components/headers/X-External-Correlation-Id"},"x-trace-id":{"$ref":"#/components/headers/x-trace-id"}},"headerSchemaId":"schema_627"}],"pointer":"/paths/~1gpi-tracking/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LookupGpiTrackingResponseContent","exampleIds":["paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LookupGpiTrackingResponseContent","exampleIds":["paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found"]}}},{"code":"429","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gpi-tracking/lookupgpitracking"}],"panels":[]}]},"httpPath":"/gpi-tracking"}],"content":{"contentType":"group","meta":{"name":"gpi-tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GPI Tracking","showPageActions":true},{"nodeType":"markdoc","content":"Look up SWIFT gpi tracking data for a cross-border payment, by UETR or Wise transfer ID. Each match returns the payment's current status and status reason, the timeline of gpi events reported by the banks in the chain, the agent BICs that handled each leg, the amounts and exchange rate applied at each step, and any charges those banks deducted."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gpi-tracking","summary":"Look up GPI tracking","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gpi-tracking/lookupgpitracking","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","description":"ISO 4217 currency code","pattern":"^[A-Z]{3}$","example":"USD"}},"components/schemas/Bic":{"id":"components/schemas/Bic","kind":"json-schema","title":"Bic","data":{"description":"Business Identifier Code, also known as Swift Code.","type":"string","pattern":"^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$"}},"components/schemas/ChallengeResultRequest":{"id":"components/schemas/ChallengeResultRequest","kind":"json-schema","title":"ChallengeResultRequest","data":{"type":"object","required":["transactionReference","challengeStatus"],"properties":{"transactionReference":{"type":"string","description":"Transaction reference as received in the 3DS challenge webhook event.","example":"148579538"},"challengeStatus":{"type":"string","description":"The customer's response to the 3DS challenge.","enum":["APPROVED","REJECTED"],"example":"APPROVED"}}}},"components/schemas/ActivityResourceType":{"id":"components/schemas/ActivityResourceType","kind":"json-schema","title":"ActivityResourceType","data":{"type":"string","description":"Type of Activity Monetary Resource.","example":"TRANSFER","enum":["ACCRUAL_CHARGE","ACQUIRING_PAYMENT","ASSETS_WITHDRAWAL","BALANCE_CASHBACK","BALANCE_INTEREST","BALANCE_TRANSACTION","BANK_DETAILS_ORDER","BATCH_TRANSFER","CARD_CASHBACK","CARD_ORDER","CARD_TRANSACTION","DIRECT_DEBIT_INSTRUCTION","DIRECT_DEBIT_TRANSACTION","FEE_REFUND","INCIDENT_REFUND","INCORPORATION_ORDER","OPERATIONAL_TRANSACTION","PAYMENT_REQUEST","REWARD","REWARDS_REDEMPTION","SEND_ORDER","SEND_ORDER_EXECUTION","TRANSFER"]}},"components/schemas/ActivityStatus":{"id":"components/schemas/ActivityStatus","kind":"json-schema","title":"ActivityStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the Activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIRES_ATTENTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Requires an end user attention."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates that this activity has yet to be completed. (Example: In progress Top Up)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPCOMING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates that this activity is scheduled to happen in the future. By default these activities will only be shown 2 days before the date. (Example: A scheduled transfer)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates that this activity is at its end state. (Example: A completed Top Up)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates that this activity is cancelled. (Example: A Top Up is cancelled)"},"children":[]}]}]}]}],"example":"IN_PROGRESS","enum":["REQUIRES_ATTENTION","IN_PROGRESS","UPCOMING","COMPLETED","CANCELLED"]}},"components/schemas/ActivityType":{"id":"components/schemas/ActivityType","kind":"json-schema","title":"ActivityType","data":{"type":"string","description":"Type of Activity.","example":"CARD_PAYMENT","enum":["ACQUIRING_PAYMENT","AUTO_CONVERSION","BALANCE_ADJUSTMENT","BALANCE_ASSET_FEE","BALANCE_CASHBACK","BALANCE_DEPOSIT","BALANCE_HOLD_FEE","BALANCE_INTEREST","BANK_DETAILS_ORDER","BATCH_TRANSFER","CARD_CASHBACK","CARD_CHECK","CARD_ORDER","CARD_PAYMENT","CASH_WITHDRAWAL","CLAIMABLE_SEND_ORDER","DIRECT_DEBIT_TRANSACTION","EXCESS_REFUND","FEE_REFUND","INCORPORATION_ORDER","INTERBALANCE","PAYMENT_REQUEST","PREFUNDING_TRANSFER","REWARD","SCHEDULED_SEND_ORDER","TRANSFER"]}},"components/schemas/Activity":{"id":"components/schemas/Activity","kind":"json-schema","title":"Activity","data":{"type":"object","description":"Activity represents a snapshot of a performed action for a profile.","properties":{"id":{"type":"string","description":"Activity id.","example":"TU9ORVRBUllfQUNUSVZJVFk6OjE0NTU4OTk4OjpDQVJEX1RSQU5TQUNUSU9OOjozNDMwNDk="},"type":{"$ref":"#/components/schemas/ActivityType"},"resource":{"type":"object","description":"The resource associated with the activity.","properties":{"type":{"$ref":"#/components/schemas/ActivityResourceType"},"id":{"type":"string","description":"The unique identifier of the resource.","example":"343049"}}},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of the Activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value can be formatted with custom tags to put emphasis on important wordings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported custom tags:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates strong emphasis on words that the end user should pay attention to."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates a positive transaction (e.g., top up to balance is successful)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates a negative transaction (e.g., amount is deducted from a balance)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Coming soon) Indicates the negation of an activity (e.g., transfer is cancelled)."},"children":[]}]}]}]}],"example":"Test Payment"},"description":{"type":"string","description":"A short description that briefly summarizes the activity."},"primaryAmount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A currency formatted text that describe the primary amount of transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of this field is intended to have units in it and should not be treated as a numeric value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One example of primaryAmount would be: \"Topping up 100 USD balance with 80 GBP\". In this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100 USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be the primaryAmount of the activity."},"children":[]}]}]}],"example":"150 JPY"},"secondaryAmount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A currency formatted text that describe the secondary amount of transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of this field is intended to have units in it and should not be treated as a numeric value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value can be empty if there is no good candidate as secondary amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One example of secondaryAmount would be: \"Topping up 100 USD balance with 80 GBP\". In this case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"80 GBP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be the secondaryAmount of the activity."},"children":[]}]}]}],"example":"1.50 SGD"},"status":{"$ref":"#/components/schemas/ActivityStatus"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the activity was created.","example":"2023-01-01T00:00:00.000Z"},"updatedOn":{"type":"string","format":"date-time","description":"Timestamp when the activity was last modified.","example":"2023-01-01T00:00:00.000Z"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","x-tags":["address"],"description":"Represents a physical address associated with a profile.","properties":{"id":{"type":"integer","format":"int64","description":"Address ID.","example":10000001},"profile":{"type":"integer","format":"int64","description":"User profile ID.","example":12345678},"details":{"type":"object","description":"Address details.","properties":{"country":{"type":"string","description":"Country code (ISO 3166-2 Country Code).","example":"US"},"firstLine":{"type":"string","description":"Address line: street, house, apartment.","example":"50 Sunflower Ave"},"postCode":{"type":"string","description":"Postal or zip code (max 30 characters).","maxLength":30,"example":"10025"},"city":{"type":"string","description":"City name.","example":"Phoenix"},"state":{"type":"string","description":"State code. Required if country is US, CA, BR, or AU.","example":"AZ"},"occupations":{"type":"array","description":"User occupations. Required for CA, IN, JP, ID, IL, MX, and within the US for state NM.","items":{"type":"object","properties":{"code":{"type":"string","description":"User occupation - any value permitted.","example":"Software Engineer"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation type - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREE_FORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FREE_FORM"],"example":"FREE_FORM"}}}}}}}}},"components/schemas/AddressRequest":{"id":"components/schemas/AddressRequest","kind":"json-schema","title":"AddressRequest","data":{"type":"object","description":"Request payload for creating or updating an address.","required":["profile","details"],"properties":{"profile":{"type":"integer","format":"int64","description":"User profile ID.","example":12345678},"details":{"type":"object","description":"Address details.","required":["country","firstLine","postCode","city"],"properties":{"country":{"type":"string","description":"Country code (ISO 3166-1 alpha-2).","example":"US"},"firstLine":{"type":"string","description":"Address line: street, house, apartment.","example":"50 Sunflower Ave"},"postCode":{"type":"string","description":"Postal / zip code (max 30 characters).","maxLength":30,"example":"10025"},"city":{"type":"string","description":"City name.","example":"Phoenix"},"state":{"type":"string","description":"State code. Required if country is US, CA, BR, or AU.","example":"AZ"},"occupations":{"type":"array","description":"User occupations. Required for CA, IN, JP, ID, IL, MX, and within the US for state NM.","items":{"type":"object","properties":{"code":{"type":"string","description":"User occupation - any value permitted.","example":"Software Engineer"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation type - always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREE_FORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FREE_FORM"],"example":"FREE_FORM"}}}}}}}}},"components/schemas/AddressRequirementsResponse":{"id":"components/schemas/AddressRequirementsResponse","kind":"json-schema","title":"AddressRequirementsResponse","data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Always \"address\".","example":"address"},"fields":{"type":"array","description":"List of fields required for the address.","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the field.","example":"Country"},"group":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Key name to include in the JSON request.","example":"country"},"type":{"type":"string","description":"Display type of field.","enum":["text","select"],"example":"select"},"refreshRequirementsOnChange":{"type":"boolean","description":"If true, call POST address-requirements when this field value changes to discover additional required fields.","example":true},"required":{"type":"boolean","description":"Indicates if the field is mandatory.","example":true},"displayFormat":{"type":["string","null"],"description":"Display format pattern.","example":null},"example":{"type":"string","description":"Example value to help users understand what to input.","example":"Germany"},"minLength":{"type":["integer","null"],"format":"int32","description":"Minimum valid length of field value.","example":null},"maxLength":{"type":["integer","null"],"format":"int32","description":"Maximum valid length of field value.","example":null},"validationRegexp":{"type":["string","null"],"description":"Regexp validation pattern.","example":null},"validationAsync":{"type":["string","null"],"description":"Deprecated. This validation will instead be performed when submitting the request.","deprecated":true,"example":null},"valuesAllowed":{"type":"array","description":"List of allowed values (for select fields).","example":[{"key":"US","name":"United States"},{"key":"GB","name":"United Kingdom"}],"items":{"type":"object","properties":{"key":{"type":"string","description":"Value key to use in the request."},"name":{"type":"string","description":"Display name for the value."}}}}}}}}}}}}}},"components/schemas/AddressRequirementsRequest":{"id":"components/schemas/AddressRequirementsRequest","kind":"json-schema","title":"AddressRequirementsRequest","data":{"type":"object","description":"Request body for retrieving address requirements based on context.","required":["details"],"properties":{"profile":{"type":"integer","format":"int64","description":"User profile ID.","example":12345678},"details":{"type":"object","description":"Address details to provide context for requirements lookup. Additional fields beyond those listed are accepted.","required":["country"],"properties":{"country":{"type":"string","description":"Country code (ISO 3166-2 Country Code).","example":"US"},"state":{"type":"string","description":"State code. Provide to discover state-dependent fields.","example":"AZ"}},"additionalProperties":{"type":"string","description":"Any other properties to provide context for the requirements lookup."}}}}},"components/schemas/BalanceType":{"id":"components/schemas/BalanceType","kind":"json-schema","title":"BalanceType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of balance account."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Standard balance account. Only one per currency per profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Savings balance (Jar). Multiple allowed per currency."},"children":[]}]}]}]}],"enum":["STANDARD","SAVINGS"],"example":"STANDARD"}},"components/schemas/Balance":{"id":"components/schemas/Balance","kind":"json-schema","title":"Balance","data":{"type":"object","x-tags":["balance"],"description":"Represents a balance account within a profile.","properties":{"id":{"type":"integer","format":"int64","description":"Balance ID.","example":200001},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"type":{"$ref":"#/components/schemas/BalanceType"},"name":{"type":["string","null"],"description":"Name of the balance. Required for SAVINGS balances.","example":null},"icon":{"type":["object","null"],"description":"Icon for the balance.","properties":{"type":{"type":"string","enum":["EMOJI"],"description":"Icon type."},"value":{"type":"string","description":"Icon value (e.g., emoji character)."}},"example":null},"investmentState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Investment state of the balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_INVESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Balance is not invested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Balance is invested in assets."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVESTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Balance is being invested into assets."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIVESTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Balance is being divested from assets."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Investment state is unknown."},"children":[]}]}]}]}],"enum":["NOT_INVESTED","INVESTED","INVESTING","DIVESTING","UNKNOWN"],"example":"NOT_INVESTED"},"amount":{"type":"object","description":"Available balance that can be used to fund transfers.","properties":{"value":{"type":"number","description":"Amount value.","example":310.86},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"reservedAmount":{"type":"object","description":"Amount reserved for transactions.","properties":{"value":{"type":"number","description":"Amount value.","example":0},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"cashAmount":{"type":"object","description":"Cash amount in the account.","properties":{"value":{"type":"number","description":"Amount value.","example":310.86},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"totalWorth":{"type":"object","description":"Current total worth.","properties":{"value":{"type":"number","description":"Amount value.","example":310.86},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"creationTime":{"type":"string","format":"date-time","description":"Date when the balance was created.","example":"2020-05-20T14:43:16.658Z"},"modificationTime":{"type":"string","format":"date-time","description":"Date when the balance was last modified.","example":"2020-05-20T14:43:16.658Z"},"visible":{"type":"boolean","description":"Whether the balance is visible to the user.","example":true}}}},"components/schemas/HoldLimitBreach":{"id":"components/schemas/HoldLimitBreach","kind":"json-schema","title":"HoldLimitBreach","data":{"type":"object","x-tags":["balance"],"description":"Represents a hold limit breach.","properties":{"id":{"type":"integer","format":"int64","description":"Hold limit breach ID.","example":200001},"profileId":{"type":"integer","format":"int64","description":"ID of the profile that owns the hold limit breach","example":123456},"amount":{"type":"number","description":"Amount value.","example":310.86},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"state":{"type":"string","description":"Current state of the hold limit breach.","enum":["OPEN","CLOSED"],"x-enumDescriptions":{"OPEN":"Hold limit breach is open and needs to be resolved.","CLOSED":"Hold limit breach is closed and resolved."},"example":"OPEN"},"closingReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the breach was closed, null if state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["AUTOMATICALLY_RESOLVED","MANUALLY_RESOLVED"],"x-enumDescriptions":{"AUTOMATICALLY_RESOLVED":"The breach was resolved automatically after the customer withdrew funds and the balance dropped below the hold limit.","MANUALLY_RESOLVED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The breach was closed by calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/balance/holdlimitbreachclose"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close Hold Limit Breach"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with a specified recipient."},"children":[]}]}]}]},"example":"AUTOMATICALLY_RESOLVED"},"createdAt":{"type":"string","format":"date-time","description":"Date when the hold limit breach was created.","example":"2020-05-20T14:43:16.658Z"},"updatedAt":{"type":"string","format":"date-time","description":"Date when the hold limit breach was last modified.","example":"2020-05-20T14:43:16.658Z"}}}},"components/schemas/BankAccountDetails":{"id":"components/schemas/BankAccountDetails","kind":"json-schema","title":"Bank Account Details","data":{"type":"object","title":"Bank Account Details","x-tags":["bank-account-details"],"description":"Bank account details for receiving money into a Wise Multi-Currency Account.","properties":{"id":{"type":["integer","null"],"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account details ID. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for preview account details that have not yet been issued."},"children":[]}]}]}],"example":14000001},"currency":{"type":"object","description":"Currency information for the bank account details.","properties":{"code":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"name":{"type":"string","description":"Currency name.","example":"Euro"}}},"title":{"type":"string","description":"Account title.","example":"Your EUR account details"},"subtitle":{"type":"string","description":"Account subtitle.","example":"IBAN, SWIFT/BIC"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account details status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Account details do not exist for the user but may be created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Account details are ready to be used by this user"},"children":[]}]}]}]}],"enum":["AVAILABLE","ACTIVE"],"example":"ACTIVE"},"deprecated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Wise has issued new account details for the same currency. Users should not use the deprecated account but may still have external references to it."},"children":[]}]}]}],"example":false},"receiveOptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available receive options for the given currency:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Local bank details to receive money in the account currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": SWIFT bank details to receive money internationally"},"children":[]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","description":"Receive option type.","enum":["LOCAL","INTERNATIONAL"],"example":"LOCAL"},"title":{"type":"string","description":"Display title for this receive option.","example":"Local"},"description":{"type":["object","null"],"description":"Description for this receive option.","properties":{"title":{"type":"string","description":"Description title.","example":"Your EUR account details"},"body":{"type":"string","description":"Description body text.","example":"Receive from a bank in the Eurozone"},"cta":{"type":["object","null"],"description":"Call-to-action details.","properties":{"label":{"type":"string","description":"CTA label.","example":"IBAN"},"content":{"type":"string","description":"CTA content.","example":"BE12 3456 7890 1234"}}}}},"details":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account details to display to users. This array varies by currency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, EUR returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_HOLDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT_CODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_NAME_AND_ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","description":"Account detail type.","example":"IBAN"},"title":{"type":"string","description":"Label to display in the UI.","example":"IBAN"},"body":{"type":"string","description":"Value to display in the UI.","example":"BE12 3456 7890 1234"},"description":{"type":["object","null"],"description":"Tooltip/popup hint content when present.","properties":{"title":{"type":"string","description":"Description title.","example":"What is an IBAN?"},"body":{"type":"string","description":"Description body (may contain HTML).","example":"

IBAN stands for International Bank Account Number.

"},"cta":{"type":["object","null"],"description":"Call-to-action details.","properties":{"label":{"type":"string","description":"CTA label.","example":"IBAN"},"content":{"type":"string","description":"CTA content.","example":"BE12 3456 7890 1234"}}}}},"hidden":{"type":"boolean","description":"Whether the field should be hidden in the UI.","example":false}}}}}}},"bankFeatures":{"type":"array","description":"Features enabled on the account.","items":{"type":"object","properties":{"key":{"type":"string","description":"Feature identifier.","example":"LOCAL_RECEIVE"},"title":{"type":"string","description":"Human-readable feature name.","example":"Receive locally"},"supported":{"type":"boolean","description":"Whether the feature is supported.","example":true}}}}}}},"components/schemas/PayInDetails":{"id":"components/schemas/PayInDetails","kind":"json-schema","title":"PayInDetails","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay-in details describe how the batch group can be funded. Only populated when a batch group is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"properties":{"type":{"type":"string","description":"Method of payment.","enum":["bank_transfer"],"example":"bank_transfer"},"reference":{"type":"string","description":"The reference that should be used when funding the transfers in the batch group. This reference should be treated as an opaque value and there should be no attempt to decode or decompose it.","example":"B5323"},"amount":{"type":"number","format":"decimal","description":"The total pay-in amount for all transactions in the batch when paying in with this reference and method.","example":12504.54},"currency":{"type":"string","description":"Three-character ISO 4217 currency code.","example":"NOK"},"name":{"type":"string","description":"Name of the bank account holder.","example":"TransferWise Ltd"},"branchName":{"type":["string","null"],"description":"Name of the bank branch. Provided only when the currency route requires it (such as JPY).","example":null},"accountNumber":{"type":["string","null"],"description":"Bank account number.","example":"9910728"},"accountType":{"type":["string","null"],"description":"Bank account type. Provided only when the currency route requires it.","example":null},"bankCode":{"type":["string","null"],"description":"Bank identifier or routing number, depending on pay-in type and currency.","example":"8301"},"bankAddress":{"type":["object","null"],"description":"Address for the receiving bank. Provided only when the currency route requires it.","properties":{"name":{"type":"string","description":"Bank name.","example":"CitiBank Europe Plc"},"firstLine":{"type":"string","description":"Street address.","example":"Bolette brygge 1"},"postCode":{"type":"string","description":"Postcode or ZIP code.","example":"0252"},"city":{"type":"string","description":"City.","example":"Oslo"},"stateCode":{"type":["string","null"],"description":"State, province, or region code.","example":null},"country":{"type":"string","description":"Country name.","example":"Norway"}}},"transferWiseAddress":{"type":["object","null"],"description":"Wise's address. Provided only when the currency route requires it.","properties":{"name":{"type":"string","description":"Wise's company name.","example":"TransferWise Ltd"},"firstLine":{"type":"string","description":"Street address.","example":"6th Floor, The Tea Building, 56 Shoreditch High Street"},"postCode":{"type":"string","description":"Postcode or ZIP code.","example":"E1 6JJ"},"city":{"type":"string","description":"City.","example":"London"},"stateCode":{"type":["string","null"],"description":"State, province, or region code.","example":null},"country":{"type":"string","description":"Country name.","example":"United Kingdom"}}},"iban":{"type":["string","null"],"description":"ISO 13616 International Bank Account Number (when available).","example":null},"bban":{"type":["string","null"],"description":"Basic Bank Account Number (BBAN). Provided only when the currency route requires it (such as NOK).","example":"83019910728"},"institutionNumber":{"type":["string","null"],"description":"Financial Institution number (3 digits). Provided only when the currency route requires it (such as CAD).","example":null},"transitNumber":{"type":["string","null"],"description":"Branch Transit Number (5 digits). Provided only when the currency route requires it (such as CAD).","example":null},"beneficiaryBankBIC":{"type":["string","null"],"description":"Beneficiary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).","example":null},"intermediaryBankBIC":{"type":["string","null"],"description":"Intermediary Bank Business Identifier Code (BIC). Provided only when the currency route requires it (such as CAD).","example":null},"fpsIdentifier":{"type":["string","null"],"description":"Faster Payment System identifier. Provided only when the currency route requires it (such as HKD).","example":null},"clearingNumber":{"type":["string","null"],"description":"Clearing number. Provided only when the currency route requires it (such as SEK).","example":null}}}},"components/schemas/BatchGroup":{"id":"components/schemas/BatchGroup","kind":"json-schema","title":"Batch Group","data":{"title":"Batch Group","x-tags":["batch-group"],"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Batch group ID.","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"version":{"type":"integer","format":"int64","description":"Batch version, used for concurrency control. This number is updated whenever there is a change to the batch group state (its status, the identity of the transfers in the batch, etc).\n\nSome API operations require this version in requests, and operations may be rejected when the requested version does not match the server's version.\n\nThe version is a signed integer and is not ordered with respect to any previous version.\n","example":123},"name":{"type":"string","description":"Descriptive name for the batch group.","example":"My batch group"},"sourceCurrency":{"type":"string","description":"Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.","example":"GBP"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current batch group status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — New batch group with zero or more transfers. Able to have more transfers added to it. Transfers in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group cannot yet be funded and paid out."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The batch group has had all desired transfers added and is now closed to further changes. Transfers in the group can now be funded and paid out. Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not imply payouts have been successfully completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARKED_FOR_CANCELLATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Cancellation of the transfers in the batch group was requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING_CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfers in the group are being cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfers in the group have been cancelled."},"children":[]}]}]}]}],"enum":["NEW","COMPLETED","MARKED_FOR_CANCELLATION","PROCESSING_CANCEL","CANCELLED"],"example":"COMPLETED"},"transferIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The IDs of all transfers successfully added to the group.","example":[234,456]},"payInDetails":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of pay-in details describing how the batch group can be funded. Provided only when the batch group is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PayInDetails"}}}}},"components/schemas/PaymentInitiation":{"id":"components/schemas/PaymentInitiation","kind":"json-schema","title":"PaymentInitiation","data":{"type":"object","description":"Payment initiation for funding a batch group via direct debit.","properties":{"id":{"type":"integer","format":"int64","description":"Payment initiation ID.","example":12345},"batchGroupId":{"type":"string","format":"uuid","description":"Batch group ID.","example":"068e186d-9632-4937-b753-af3e53f4d0b0"},"reference":{"type":"string","description":"Payment reference that will be passed to the network. Can be used for reconciliation.","example":"B1234567"},"userId":{"type":"integer","format":"int64","description":"The ID of the user who initiated this payment.","example":33333333},"profileId":{"type":"integer","format":"int64","description":"The ID of the profile this payment belongs to.","example":44444444},"type":{"type":"string","description":"Payment type.","enum":["DIRECT_DEBIT"],"example":"DIRECT_DEBIT"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment initiation status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment initiation created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment is being processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment completed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGED_BACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payment was charged back"},"children":[]}]}]}]}],"enum":["NEW","PROCESSING","COMPLETED","FAILED","CHARGED_BACK"],"example":"NEW"},"accountId":{"type":"integer","format":"int64","description":"External account ID associated with the payment.","example":1},"transferId":{"type":["integer","null"],"format":"int64","description":"Transfer ID of the direct debit payment. Present only after the direct debit is initiated.","example":null},"createdTime":{"type":"string","format":"date-time","description":"Date and time when the payment initiation was created.","example":"2022-01-01T19:51:41.423404Z"}}}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"type":"object","description":"The Card resource represents a Wise card linked to a profile.","x-tags":["card"],"properties":{"token":{"type":"string","description":"Unique identifier for the card.","example":"ca0c8154-1e14-4464-a1ce-dcea7dc3de52"},"profileId":{"type":"integer","format":"int64","description":"Profile ID that owns this card.","example":123456},"clientId":{"type":"string","description":"Client ID of the partner that issued the card.","example":"wise_api_docs"},"status":{"type":"object","description":"Current status of the card.","properties":{"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status value. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is active and can be used"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is inactive and all transactions will be declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is blocked and cannot be reversed back to any state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is temporarily blocked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is suspended by Wise temporarily (do not display to end customers)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cardholder data (e.g. PAN, PIN) has been purged after the retention period (555 days after the card's expiry date)"},"children":[]}]}]}]}],"enum":["ACTIVE","INACTIVE","BLOCKED","FROZEN","PARTNER_SUSPENDED","EXPIRED","PURGED"],"example":"ACTIVE"}}},"cardHolderName":{"type":"string","description":"Name of the card holder.","example":"John Smith"},"expiryDate":{"type":"string","format":"date-time","description":"Date when the card will expire.","example":"2028-05-31T00:00:00Z"},"lastFourDigits":{"type":"string","description":"Last 4 digits of the card number.","example":"6320"},"bankIdentificationNumber":{"type":"string","description":"Bank identification number (BIN) of the card.","example":"459661"},"phoneNumber":{"type":"string","description":"Phone number associated with the card.","example":"+441234567890"},"cardProgram":{"type":"object","description":"Card program details.","properties":{"name":{"type":"string","description":"Name of the card program.","example":"VISA_DEBIT_BUSINESS_UK_1"},"scheme":{"type":"string","description":"Card network scheme.","enum":["VISA","MASTERCARD"],"example":"VISA"},"defaultCurrency":{"type":"string","description":"Default currency of the card.","example":"GBP"},"cardType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the card. E.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHYSICAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIRTUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"VIRTUAL"}}},"unlockSpendingPermissions":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method with which physical card spending permissions can be unlocked. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITH_PARTNER_API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unlock via Partner API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITH_FIRST_CHIP_AND_PIN_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unlock with first chip and PIN transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not applicable (for virtual cards)"},"children":[]}]}]}]}],"enum":["WITH_PARTNER_API","WITH_FIRST_CHIP_AND_PIN_TRANSACTION","NONE"],"example":"WITH_PARTNER_API"},"creationTime":{"type":"string","format":"date-time","description":"Time when the card was created.","example":"2022-05-31T01:43:24.596321434Z"},"modificationTime":{"type":"string","format":"date-time","description":"Time when the card was last modified.","example":"2022-05-31T01:43:24.596321825Z"}}}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"type":"object","description":"Spending permission configuration for a card.","x-tags":["card"],"required":["type","isEnabled"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of transaction this permission controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissions available on all cards:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Online transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawals"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOBILE_WALLETS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Digital wallet payments (Apple Pay, Google Pay)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional permissions available on physical cards:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_MAGSTRIPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Physical point-of-sale transactions with magnetic stripe"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_CONTACTLESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Physical point-of-sale contactless transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_CHIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Physical point-of-sale transactions with chip"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual cards do not return physical point-of-sale permissions. Only permissions returned for the card can be updated."},"children":[]}]}]}],"enum":["ECOM","POS_CHIP","POS_MAGSTRIPE","POS_CONTACTLESS","ATM_WITHDRAWAL","MOBILE_WALLETS"],"example":"ECOM"},"isEnabled":{"type":"boolean","description":"Indicates if this permission type is enabled.","example":false},"isLocked":{"type":"boolean","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if this permission is locked. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this permission cannot be updated."},"children":[]}]}]}],"example":false}}}},"components/schemas/ProductionStatus":{"id":"components/schemas/ProductionStatus","kind":"json-schema","title":"ProductionStatus","data":{"type":"object","description":"Represents the production status of a card at a kiosk machine.","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current production status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is ready for production"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is in production at the kiosk machine"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is produced and collected. This is a final state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCTION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card production failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card production request failed"},"children":[]}]}]}]}],"enum":["READY","IN_PROGRESS","PRODUCED","PRODUCTION_ERROR","REQUEST_ERROR"],"example":"IN_PROGRESS"},"kioskId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier that specifies which kiosk machine is producing the card. When the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this value is null."},"children":[]}]}]}],"example":"WIS00001"},"occurredAt":{"type":"string","format":"date-time","description":"Time when the card production request has been sent to the kiosk machine (ISO 8601 format).","example":"2024-01-01T12:24:56.121Z"},"errorCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code returned when card production is not successful. Nullable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - An error occurred on the server"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The request has already been submitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KIOSK_ID_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The kiosk ID does not exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_TYPE_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card type does not exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_FIELD_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Some field values are unexpected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_PIN_FORMAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The PIN does not follow ISO0 or ISO2 standard"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY_OR_NULL_FIELD_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Some required fields are empty or null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY_OR_NULL_OR_WRONG_SIZE_FIELD_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Some required fields are empty, null, or have incorrect lengths"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARSET_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The character set for some fields is not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_FIELD_FORMAT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Some field formats are invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_FIELD_ENCODING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The encoding for some fields is not expected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDATA_ENCODING_OR_FORMATING_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The encoding or formatting for XML text field values is incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN_LENGTH_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The PIN length is incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN_VERIFICATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The PIN cannot be verified because the server is unreachable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATA_PREPARATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The server failed to parse the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_DATA_RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only part of the expected data has been received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_BRANCH_LINKED_TO_KIOSK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The kiosk has not been linked to any branch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMAGE_SERVER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The image server is unreachable or failed to process the data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAN_ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The PAN already exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRINTER_OR_SATELLITE_NOT_READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The printer or satellite is not ready to start the production"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUEST_CREATED_BUT_NOT_STARTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The request has been created, but production is pending until the printer or satellite is ready"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNABLE_TO_ACCEPT_REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The system is currently busy and cannot accept new requests at this time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCTION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_NOT_AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: central base not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_DB_NOT_AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: database not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_NETWORK_NOT_AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: network not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_AUTHENTICATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: user authentication verification failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_SERVICE_NOT_ALLOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: the accessed service requires a higher security level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CB_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Main server error: timeout occurred on the Central Base side"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DP_NOT_AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Data processing error: the Data preparation module is not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DP_IO_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Data processing error: Input/Output error when communicating with the DP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DP_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Data processing error: timeout error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAT_SERVER_NOT_REACHABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Satellite agent error: the server is not reachable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAT_AUTHENTICATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Satellite agent error: user authentication failed on satellite"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAT_NETWORK_NOT_AVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Satellite agent error: the network is not available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_NOT_REACHABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer is not reachable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_SETUP_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer setup is incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer timeout"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_RIBBON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: ribbon error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_LOCK_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer physically unlocked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_RIBBON_MISSING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: ribbon is missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_RIBBON_ENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: ribbon has ended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_COVER_OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer cover is open"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRT_PAUSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Printer error: printer paused"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_UNEXPECTED_DATA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: production data is incorrect"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_FEEDER_EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: feeder is empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_FEEDER_JAM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: feeder card jam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_HOPPER_FULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: hopper is full"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_HOPPER_DOOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: hopper door is open"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_HOPPER_JAM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: hopper card jam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_MAGSTRIPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: error occurred during magstripe encoding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_SMARTCARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: error occurred during chip personalization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_EMBOSSER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: error occurred during embossing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_TIMEOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: production timeout has been reached"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_REJECT_FULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: reject box is full"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_SMARTCARD_CARD_NOT_IN_READER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: card is not in reader"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRD_FINAL_VALIDATION_NOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: user has rejected card production"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INV_NOT_INITIALIZED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Production error: inventory not initialized"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unknown error"},"children":[]}]}]}]}],"example":"PIN_VERIFICATION_FAILED"},"description":{"type":["string","null"],"description":"Detailed description of the error code.","example":"The PIN cannot be verified because the server is unreachable"}}}},"components/schemas/CardOrder":{"id":"components/schemas/CardOrder","kind":"json-schema","title":"Card Order","data":{"type":"object","title":"Card Order","x-tags":["card-order"],"properties":{"id":{"type":"integer","format":"int64","description":"ID of the card order.","example":142},"profileId":{"type":"integer","format":"int64","description":"Profile ID.","example":123456},"clientId":{"type":"string","description":"Client ID.","example":"your-client-id"},"cardProgram":{"type":"object","description":"The card program associated with this card order. A Card Program is what Wise refers to all the cards that you will be issuing with us, grouped by product type and by issuing country.","properties":{"name":{"type":"string","description":"The name of the card program.","example":"VISA_DEBIT_BUSINESS_UK_1_PHYSICAL_CARDS_API"},"scheme":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The network of the card program:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MASTERCARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISA"},"children":[]}]}]}]}],"enum":["MASTERCARD","VISA"],"example":"VISA"},"defaultCurrency":{"type":"string","description":"The default currency assigned to the card program.","example":"GBP"},"cardType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the card:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIRTUAL_NON_UPGRADEABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHYSICAL"},"children":[]}]}]}]}],"enum":["VIRTUAL_NON_UPGRADEABLE","PHYSICAL"],"example":"PHYSICAL"}}},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address set during card order. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for physical cards. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for virtual cards (defaults to the profile address, if omitted). Fields vary by country. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/card-address-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card address validation guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for country-specific fields and validation rules."},"children":[]}]}]}],"additionalProperties":true,"properties":{"firstLine":{"type":"string","description":"Card holder's address.","example":"56 Shoreditch High St"},"secondLine":{"type":["string","null"],"description":"Card holder's address.","example":"The Tea Bldg"},"thirdLine":{"type":["string","null"],"description":"Card holder's address.","example":null},"city":{"type":"string","description":"Card holder's city.","example":"London"},"postCode":{"type":"string","description":"Card holder's postal code.","example":"E1 6JJ"},"state":{"type":["string","null"],"description":"Card holder's state.","example":null},"country":{"type":"string","description":"Card holder's country (ISO 3166-1 alpha-2).","example":"GB"}}},"cardToken":{"type":["string","null"],"description":"Token of the card associated with card order. Nullable.","example":"4dc0be88-903f-49e4-8237-735f1139e3dd"},"replacesCard":{"type":["string","null"],"description":"Token of the card being replaced by this replacement card order. Nullable.","example":"4dc0be88-903f-49e4-8237-735f1139e3dd"},"creationTime":{"type":"string","format":"date-time","description":"Time when the card order is created.","example":"2023-07-31T01:43:24.596321434Z"},"modificationTime":{"type":"string","format":"date-time","description":"Time when the card order was last modified.","example":"2023-07-31T01:43:24.596321825Z"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the card order. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-order#card-order-status-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card order status flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"enum":["PLACED","REQUIREMENTS_FULFILLED","CARD_DETAILS_CREATED","PRODUCED","COMPLETED","CANCELLED","RETURNED"],"example":"PRODUCED"},"cardHolderName":{"type":"string","description":"Name of the card holder.","example":"John Smith"},"phoneNumber":{"type":"string","description":"Phone number associated with the card order.","example":"+441234567890"},"lifetimeLimit":{"type":["number","null"],"description":"Maximum amount of spending on the card once issued. Nullable.","example":100},"deliveryEstimate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated time when the card will be delivered. There are few scenarios to be mindful of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For virtual card the delivery estimate will be close to the creationTime, as it does not require delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For physical card in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the delivery estimate is calculated assuming that the order requirements will be fulfilled today (refreshed daily)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For physical card after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLACED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, we provide a best effort estimation, and it should not be used as delivery timing as we will have separate delivery tracking (subject to region availability) for physical card that is coming soon."},"children":[]}]}]}]}],"example":"2023-10-30T07:11:00.848681Z"},"deliveryDetails":{"type":"object","description":"Delivery details of a physical card order. For virtual cards, this value is null.","properties":{"deliveryOption":{"type":"string","description":"The delivery option used on the card order.","enum":["POSTAL_SERVICE_STANDARD","POSTAL_SERVICE_WITH_TRACKING","KIOSK_COLLECTION"],"example":"POSTAL_SERVICE_WITH_TRACKING"},"deliveryVendor":{"type":["string","null"],"description":"The name of the delivery vendor.","example":"DHL"},"trackingUrl":{"type":["string","null"],"description":"The URL to track the card delivery.","example":"https://www.dhl.com/gb-en/home/tracking/tracking-express.html?submit=1&tracking-id=1999473803"},"trackingNumber":{"type":["string","null"],"description":"The tracking number of the card delivery.","example":"1999473803"}}}}}},"components/schemas/CardTransaction":{"id":"components/schemas/CardTransaction","kind":"json-schema","title":"Card Transaction","data":{"title":"Card Transaction","type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are only present when retrieving a single transaction by ID, and will not be present in the list transactions response."},"children":[]}]}]}],"properties":{"id":{"type":"integer","format":"int64","description":"ID of the transaction","example":342671},"cardToken":{"type":"string","description":"Unique identifier of the card","example":"59123122-223d-45f9-b840-0ad4a4f80937"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_CREDIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_ADVANCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_PURCHASE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_PURCHASE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]}]}]}]}],"enum":["ACCOUNT_CREDIT","ACCOUNT_FUNDING","CASH_ADVANCE","CASH_WITHDRAWAL","CHARGEBACK","CREDIT_TRANSACTION","ECOM_PURCHASE","POS_PURCHASE","REFUND"],"example":"ECOM_PURCHASE"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-state"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the transaction. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]}]}]}]}],"enum":["IN_PROGRESS","COMPLETED","DECLINED","CANCELLED","UNKNOWN"],"example":"IN_PROGRESS"},"declineReason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-decline-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decline reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if applicable"},"children":[]}]}]}],"example":null},"detailedDeclineReason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-detailed-decline-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detailed decline reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if applicable"},"children":[]}]}]}],"example":null},"creationTime":{"type":"string","format":"date-time","description":"When the transaction was created","example":"2022-11-28T08:17:54.241Z"},"modificationTime":{"type":"string","format":"date-time","description":"When the transaction was last updated","example":"2022-11-28T08:17:54.241Z"},"purgeTime":{"type":["string","null"],"format":"date-time","description":"Time at which reserved funds will be released after the authorisation hold expires","example":"2022-11-28T08:17:54.241Z"},"transactionAmount":{"type":"object","description":"Transaction amount, including any embedded fees such as ATM fees that are not applied by Wise","properties":{"amount":{"type":"number","description":"Transaction amount","example":1.4},"currency":{"type":"string","description":"Currency code","example":"SGD"}}},"fees":{"type":"array","description":"Array of fees","items":{"type":"object","properties":{"amount":{"type":"number","description":"Fee amount","example":0.1},"currency":{"type":"string","description":"Currency code","example":"SGD"},"fee_type":{"type":"string","description":"Fee type","example":"ATM_ACQUIRER"}}}},"transactionAmountWithFees":{"type":"object","description":"Transaction amount including all fees","properties":{"amount":{"type":"number","description":"Transaction amount including all fees","example":1.5},"currency":{"type":"string","description":"Currency code","example":"SGD"}}},"merchant":{"type":"object","description":"Merchant information","properties":{"name":{"type":"string","description":"Name of the merchant","example":"Test Payment"},"location":{"type":"object","description":"Merchant location","properties":{"country":{"type":["string","null"],"description":"Country where merchant is located","example":"France"},"city":{"type":["string","null"],"description":"City where merchant is located","example":"Rouen"},"zipCode":{"type":["string","null"],"description":"Zip code where merchant is located","example":"00000"},"region":{"type":["string","null"],"description":"Region where merchant is located","example":null},"state":{"type":["string","null"],"description":"State where merchant is located","example":null}}},"category":{"type":"object","description":"Merchant category","properties":{"name":{"type":"string","description":"Category of the merchant","example":"MISCELLANEOUS_FOOD_STORES_CONVEN"},"code":{"type":"string","description":"MCC code of the merchant","example":"5999"},"description":{"type":"string","description":"Description of the merchant category","example":"5999 R Miscellaneous and Special"}}}}},"authorisationMethod":{"type":"string","description":"Authorisation method","example":"MANUAL_ENTRY"},"approvalCode":{"type":["string","null"],"description":"Also called authorization code. This can be used to prove ownership of a customer's card/account to a merchant","example":"913647"},"billingAmount":{"type":"object","description":"Billing amount","properties":{"amount":{"type":"number","description":"Billing amount","example":1.1},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"arn":{"type":["string","null"],"description":"Acquirer reference number","example":"04300014127798385983852"},"pinValidationResult":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN validation result. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_RECEIVED"},"children":[]}]}]}]}],"enum":["ONLINE_PIN_VALIDATED","ONLINE_PIN_INVALID","OFFLINE_PIN_VALIDATED","OFFLINE_PIN_INVALID","NOT_RECEIVED"],"example":"ONLINE_PIN_VALIDATED"},"balanceChannelReferenceId":{"type":["string","null"],"description":"Balance channel reference ID associated with the card transaction","example":"6e71018d-2f4d-4fc3-6711-f517f4664712"},"debits":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of debits. Only present when retrieving a single transaction by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debits list is a non-aggregated list of debit movements, meaning that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balanceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not unique in the list. For example, a cancelled transaction may have a list of 2 debits where the absolute values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debitedAmount.amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forAmount.amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee.amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the same, but one is the negation of the other due to a reservation (first debit) which was then released (second debit with negated amounts). You can choose to perform the aggregation in your system or display the full list of debits to the end customer."},"children":[]}]}]}],"items":{"type":"object","properties":{"balanceId":{"type":"integer","format":"int64","description":"Balance ID","example":52832},"debitedAmount":{"type":"object","description":"Amount taken from the balance","properties":{"amount":{"type":"number","description":"Amount","example":1.1},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"forAmount":{"type":"object","description":"Amount converted to","properties":{"amount":{"type":"number","description":"Amount","example":1.5},"currency":{"type":"string","description":"Currency code","example":"SGD"}}},"rate":{"type":"number","description":"Exchange rate of debitedAmount to forAmount","example":1.36363636364},"fee":{"type":"object","description":"Conversion fee","properties":{"amount":{"type":"number","description":"Conversion fee amount","example":0.04},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"creationTime":{"type":"string","format":"date-time","description":"Creation time of debit","example":"2022-11-28T08:17:54.241Z"}}}},"credits":{"type":"array","description":"Array of credits. Only present when retrieving a single transaction by ID","items":{"type":"object","properties":{"balanceId":{"type":"integer","format":"int64","description":"Balance ID","example":52832},"creditedAmount":{"type":"object","description":"Amount credited to the balance","properties":{"amount":{"type":"number","description":"Amount","example":1.5},"currency":{"type":"string","description":"Currency code","example":"SGD"}}},"creationTime":{"type":"string","format":"date-time","description":"Creation time of credit","example":"2022-11-28T08:17:54.241Z"}}}},"relayAuthorisationData":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relayed authorisation response data, only available if the partner has opted in for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/relayed-authorisation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relayed authorisation"},"children":[]}]}]}]}],"properties":{"responseCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/relayed-authorisation#authorisation-response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ResponseCode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the relayed authorisation. One of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSING_ERROR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_SUPPORTED_CURRENCY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_SUPPORTED_MCC_FOR_COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED_COUNTRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSACTION_TYPE_NOT_SUPPORTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_FRAUD"},"children":[]}]}]}]}],"enum":["APPROVED","PROCESSING_ERROR","NON_SUPPORTED_CURRENCY","NON_SUPPORTED_MCC_FOR_COUNTRY","BLOCKED_COUNTRY","TRANSACTION_TYPE_NOT_SUPPORTED","SUSPECTED_FRAUD"],"example":"APPROVED"},"fallback":{"type":"boolean","description":"Indicating whether there was a fallback applied by Wise","example":true}}}}}},"components/schemas/Comparison":{"id":"components/schemas/Comparison","kind":"json-schema","title":"Comparison","data":{"title":"Comparison","type":"object","additionalProperties":true,"description":"V4 comparison response containing price and speed estimates from various money transfer providers.","properties":{"sourceCurrency":{"type":["string","null"],"description":"ISO 4217 source currency code","example":"GBP"},"targetCurrency":{"type":["string","null"],"description":"ISO 4217 target currency code","example":"EUR"},"sourceCountry":{"type":["string","null"],"description":"Source country (ISO 3166-1 Alpha-2 code)","example":null},"targetCountry":{"type":["string","null"],"description":"Target country (ISO 3166-1 Alpha-2 code)","example":null},"providerCountry":{"type":["string","null"],"description":"Provider country (ISO 3166-1 Alpha-2 code)","example":null},"providerTypes":{"type":"array","description":"List of provider types included in the response","items":{"type":"string"},"example":["bank","moneyTransferProvider"]},"amount":{"type":"number","description":"The comparison amount","example":10000},"amountType":{"type":"string","description":"Whether the amount represents a send amount or recipient gets amount","example":"SEND"},"providers":{"type":"array","description":"List of providers with their estimated quotes","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer","format":"int64","description":"Provider ID","example":39},"alias":{"type":"string","description":"Provider alias (lowercase slug name)","example":"wise"},"name":{"type":"string","description":"Provider name (presentational / formal name)","example":"Wise"},"logos":{"type":"object","description":"URLs pointing to provider logos (svg, png)","properties":{"normal":{"type":"object","properties":{"svgUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo.svg"},"pngUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo.png"}}},"inverse":{"type":"object","properties":{"svgUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.svg"},"pngUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.png"}}},"white":{"type":"object","properties":{"svgUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo_white.svg"},"pngUrl":{"type":["string","null"],"example":"https://wise.com/public-resources/assets/logos/wise-personal/logo_white.png"}}},"circle":{"type":"object","properties":{"svgUrl":{"type":["string","null"],"example":"https://dq8dwmysp7hk1.cloudfront.net/logos/wise-mark.svg"},"pngUrl":{"type":["string","null"],"example":null}}},"altText":{"type":"string","description":"Alt text for the provider logo","example":"Wise"}}},"type":{"type":"string","description":"Provider type: bank, money transfer provider, or travel money","example":"moneyTransferProvider"},"partner":{"type":"boolean","description":"Whether a partner of Wise or not","example":false},"quotes":{"type":"array","description":"An array of estimated quotes per provider","items":{"type":"object","additionalProperties":true,"properties":{"rate":{"type":"number","description":"The live estimated exchange rate for the provider for this quote","example":1.15989},"fee":{"type":"number","description":"The estimated fee for the provider for this quote","example":37.12},"dateCollected":{"type":"string","description":"The date of collection for the original quote","example":"2019-10-22T14:36:43Z"},"sourceCountry":{"type":["string","null"],"description":"Source country (ISO 3166-1 Alpha-2 code)","example":null},"targetCountry":{"type":["string","null"],"description":"Target country (ISO 3166-1 Alpha-2 code)","example":null},"markup":{"type":"number","description":"Percentage markup on the quoted rate compared to the mid-market rate","example":0},"receivedAmount":{"type":["number","null"],"description":"The total estimated received amount for the provider for this quote (non-null only if a send amount request was made)","example":11555.84},"sendAmount":{"type":["number","null"],"description":"The total estimated send amount for the provider for this quote (non-null only if a recipient gets amount request was made)","example":null},"isConsideredMidMarketRate":{"type":"boolean","description":"Whether the provider's rate is close enough to the true mid-market rate to be classified as a mid-market rate","example":true},"deliveryEstimation":{"type":"object","description":"Delivery estimation details - i.e. a speed estimate","properties":{"duration":{"type":"object","description":"Duration range","properties":{"min":{"type":["string","null"],"description":"Minimum quoted time for transaction delivery (ISO 8601 duration format)","example":"PT20H8M16.305111S"},"max":{"type":["string","null"],"description":"Maximum quoted time for transaction delivery (ISO 8601 duration format)","example":"PT20H8M16.305111S"}}},"providerGivesEstimate":{"type":"boolean","description":"Whether a provider publicly surfaces a speed estimate or not","example":true}}}}}}}}}}}},"components/schemas/DirectDebitAccount":{"id":"components/schemas/DirectDebitAccount","kind":"json-schema","title":"Direct Debit Account","data":{"title":"Direct Debit Account","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Direct debit account ID","example":1},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the bank account. 3-character currency code — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ACH, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for EFT"},"children":[]}]}]}],"example":"USD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for which the account is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — US direct debit (USD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — CA direct debit (CAD)"},"children":[]}]}]}]}],"enum":["ACH","EFT"],"example":"ACH"},"details":{"type":"object","description":"Bank account details","properties":{"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid ABA routing number. For CAD direct debits, the routing number is a combination of an institution number + transit number"},"children":[]}]}]}],"example":"000000000"},"accountNumber":{"type":"string","description":"A valid bank account number","example":"0000000000"},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHECKING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Checking account (USD, CAD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Savings account (USD, CAD)"},"children":[]}]}]}]}],"enum":["CHECKING","SAVINGS"],"example":"CHECKING"}}}}}},"components/schemas/DisputeReason":{"id":"components/schemas/DisputeReason","kind":"json-schema","title":"DisputeReason","data":{"title":"DisputeReason","type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of reasons available for the dispute. Top-level codes include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_DISPENSED_NO_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WRONG_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TROUBLE_WITH_GOODS_SERVICES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT_CHARGED_AGAIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAUTHORIZED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a reason has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the sub-option reason code when submitting a dispute."},"children":[]}]}]}],"example":"UNAUTHORIZED"},"description":{"type":"string","description":"The description of the dispute reason.","example":"I did not make, authorize, or participate in this transaction"},"isFraud":{"type":"boolean","description":"Flag indicating that the dispute reason is fraud-related.","example":false},"tooltip":{"type":"string","description":"Text to display when showing the dispute form to your users.","example":"Choose this if you don't know the merchant or have never purchased anything from them"},"supportsMultipleTransactions":{"type":"boolean","description":"Whether the dispute supports multiple transactions.","example":false},"subOptions":{"type":"array","description":"Optional list of sub-reasons that should be used as the dispute reason.","items":{"$ref":"#/components/schemas/DisputeReason"}}}}},"components/schemas/Dispute":{"id":"components/schemas/Dispute","kind":"json-schema","title":"Dispute","data":{"title":"Dispute","type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the dispute.","example":"b4eae16c-b3a9-4327-b0bd-6a2ad430d803"},"transactionId":{"type":"integer","format":"int64","description":"Card transaction ID.","example":476873},"profileId":{"type":"integer","format":"int64","description":"Profile ID.","example":14547572},"reason":{"type":"string","description":"Dispute reason code.","example":"WRONG_AMOUNT"},"status":{"type":"string","description":"Dispute overall status.","enum":["ACTIVE","CLOSED"],"example":"CLOSED"},"subStatus":{"type":"string","description":"Dispute detailed status.","enum":["SUBMITTED","IN_REVIEW","REFUNDED","REJECTED","WITHDRAWN","CONFIRMED","REFUND_IN_PROGRESS","ATTEMPTING_RECOVERY","RECOVERY_UNSUCCESSFUL"],"example":"WITHDRAWN"},"statusMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Withdrawn"},"createdAt":{"type":"string","format":"date-time","description":"Time when the dispute was created.","example":"2024-03-18T03:47:52.493Z"},"createdBy":{"type":"string","description":"Creator of the dispute. Currently set to the user ID.","example":"9867661"},"lastUpdatedAt":{"type":"string","format":"date-time","description":"Time when the dispute was last updated.","example":"2024-03-27T02:30:27.374Z"},"canWithdraw":{"type":"boolean","description":"Whether the dispute can be withdrawn.","example":false}}}},"components/schemas/kyc-requirement":{"id":"components/schemas/kyc-requirement","kind":"json-schema","title":"KYC Requirement","data":{"title":"KYC Requirement","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object returned as part of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-review"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Review"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, which includes information about a required evidence, its state, and any additional information that might be required."},"children":[]}]}]}],"x-tags":["kyc-review"],"type":"object","properties":{"key":{"type":"string","description":"The name of the KYC requirement. A single KYC Requirement should appear in the requirements list at most once.","example":"ID_DOCUMENT"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the KYC requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the information is pending. Either the Hosted KYC flow or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint should be used to fulfil the requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the required information has been retrieved and the KYC requirement is being reviewed. No action is needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the required information has been received and verified on our side. No action is needed."},"children":[]}]}]}]}],"enum":["NOT_PROVIDED","IN_REVIEW","VERIFIED"],"example":"NOT_PROVIDED"},"apiCollectionSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the requirement can be provided via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the requirement should be provided via the Hosted KYC flow."},"children":[]}]}]}],"example":true},"additionalRequirements":{"type":["array","null"],"description":"List of additional submissions that are needed to fulfill this requirement. These can appear when the originally submitted evidence is a wrong document, wrong format, incomplete or otherwise insufficient. Only provided if not empty.\n","items":{"type":"object","properties":{"additionalRequirementId":{"type":"string","format":"uuid","description":"Unique identifier for an additional requirement, generated by Wise.","example":"8b789c45-60ae-475d-b667-c8714db9a6a4"},"key":{"type":"string","description":"A key outlining what type of evidence is additionally required","enum":["ACKNOWLEDGEMENT,","DOCUMENT","WRITTEN_ANSWER","DOCUMENT_AND_WRITTEN_ANSWER","DOCUMENT_OR_WRITTEN_ANSWER","EMAIL","CUSTOM_REQUEST"],"example":"DOCUMENT_OR_WRITTEN_ANSWER"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the additional requirement. This state should be treated as independent of the parent KYC Requirement's state. They can, but don't have to, change together."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the information is pending. Either the Hosted KYC flow or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint should be used to fulfil the additional requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the required information has been retrieved and the additional requirement is being reviewed. No action is needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the required information has been received and verified on our side. No action is needed."},"children":[]}]}]}]}],"enum":["NOT_PROVIDED","IN_REVIEW","VERIFIED"],"example":"NOT_PROVIDED"},"reasons":{"type":"object","description":"Contains information about the reason this additional requirement has been requested.","properties":{"errorCode":{"type":"string","description":"Code for the reason this additional requirement has been requested.","enum":["NEEDED","WRONG_DOCUMENT","EXPIRED","INVALID_TRADING_ADDRESS","MISSING_ONE_SIDE","MISSING_COUNTRY_OF_RESIDENCE","MISSING_DIRECTORS","MISSING_UBOS","NO_UBO_DOC_REQUIRED","MISMATCH_NAME","MISMATCH_DATE_OF_BIRTH","AGENT_DETAILS_PROVIDED","DIRECTOR_IS_BUSINESS","UBO_IS_BUSINESS","UNCLEAR","WEBSITE_LINK_BROKEN","BUSINESS_NAME_NOT_ON_WEBSITE","DRIVING_LICENSE_NOT_ACCEPTED","BUSINESS_NOT_REGISTERED","OTHER"],"example":"EXPIRED"},"description":{"type":"string","example":"The provided document or information has expired. A valid document is required."},"dateTime":{"type":"string","format":"date-time","description":"Timestamp marking when this additional requirement was requested.","example":"2026-04-13T10:54:21.929314"}}},"attributes":{"type":"object","description":"Contains metadata information about the additional requirement. Not returned if empty.","properties":{"fields":{"type":"object","description":"Not returned if empty","properties":{"name":{"type":"string","description":"The name of the affected person(s) or business","examples":["John Smith","Hannah Myers and John Smith","My Business Inc."]},"website":{"type":"string","description":"The URL of the affected website","examples":["https://example.com"]},"businessName":{"type":"string","description":"The name of the affected business","examples":["My Business Inc."]},"owningBusinessName":{"type":"string","description":"The name of the affected owning business","examples":["Owning Business Inc."]},"markdownText":{"type":"string","description":"Free format text written by a Wise Agent in markdown format.","example":"Requirement details were unclear, *please* provide a clear scan where:\n\n* All information is clearly readable\n* The document is in colour"}}},"issues":{"type":"array","description":"A list of issues with the previously uploaded document. Not returned if empty","items":{"type":"string","enum":["CANNOT_BE_SCREENSHOT","INCORRECT_FILE_FORMAT","NEED_COLOUR_VERSION","POOR_QUALITY"]},"example":["CANNOT_BE_SCREENSHOT","NEED_COLOUR_VERSION"]}}}}}},"versions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiCollectionSupported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Lists the available versions and their validity."},"children":[]}]}]}],"items":{"type":"object","properties":{"version":{"type":"string","description":"The version identifier.","example":"v1"},"validUntil":{"type":["string","null"],"format":"date","description":"If present, indicates the expiry date of this version (ISO 8601).","example":"2026-06-30"}}}},"attributes":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditional:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only present for certain requirement types that provide additional contextual information. The keys within this object vary depending on the parent requirement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/kyc-requirement-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for details on which requirement types support attributes and what keys they contain."},"children":[]}]}]}]}}}},"components/schemas/kyc-review":{"id":"components/schemas/kyc-review","kind":"json-schema","title":"KYC Review","data":{"title":"KYC Review","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The return object of most KYC Review endpoints, which includes information about the given KYC Review such as status, trigger references, and a list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-tags":["kyc-review"],"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for a KYC Review resource, generated by Wise.","example":"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"},"status":{"type":"string","description":"Aggregated state of the underlying requirement set. Any of the states below could move into any other state.\n","enum":["NEW","PASSED","PASSED_WITH_REQUIREMENTS","WAITING_CUSTOMER_INPUT","PROCESSING"],"example":"WAITING_CUSTOMER_INPUT"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp marking the creation of the KYC Review.","example":"2024-09-03T16:22:02.257725"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp marking the last update of the KYC Review.","example":"2024-09-03T16:29:41.147522"},"requiredBy":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp by which the underlying requirement set needs to be verified to not block the customer. Only relevant if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-09-03T16:22:02.257725"},"triggerReferences":{"type":"array","description":"List of trigger reference objects.","items":{"type":"object","description":"An object that refers to the action or process this KYC Review pertains to.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action or process this KYC Review is for. Usually a reference to which product this KYC Review pertains to (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROACTIVE_SEND_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO_REQUEST"},"children":[]}]}]}]}],"example":"QUOTE"},"triggerData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value object containing metadata of the underlying product object that triggered the KYC Review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that refers to their respective IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains a list of currencies (e.g. USD, SGD, EUR) that the bank details have been created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields and their data types for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerReference.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (uuid)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (long)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (long)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list of string)"},"children":[]}]}]}]}],"additionalProperties":true,"example":{"id":"ba83a43a-f623-46f0-956d-196c13e2ab01"}}}}},"redirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected at the end of the flow. Can contain query params and path fragments. It has to be a valid URL as per "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc2396.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 2396"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provided by the caller in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"kycreviewredirecturlupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update redirect URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]}]}]}],"example":"https://example.com"},"requirements":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[Requirement]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, where each inner list represents a combination of possible requirements to be provided. To fulfil the whole KYC Review, at least one item from each inner list should be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the requirements are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[a, b], [c, d]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it should be read as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(a or b) and (c or d)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/kyc-requirement"}}}}}},"components/schemas/kyc-review-with-link":{"id":"components/schemas/kyc-review-with-link","kind":"json-schema","title":"KYC Review with a Hosted KYC link","data":{"title":"KYC Review with a Hosted KYC link","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The return object of the KYC Review Update endpoint, which includes information about the given KYC Review such as status, trigger references, a list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as well as a linik to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosted KYC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-tags":["kyc-review"],"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for a KYC Review resource, generated by Wise.","example":"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"},"status":{"type":"string","description":"Aggregated state of the underlying requirement set. Any of the states below could move into any other state.\n","enum":["NEW","PASSED","PASSED_WITH_REQUIREMENTS","WAITING_CUSTOMER_INPUT","PROCESSING"],"example":"WAITING_CUSTOMER_INPUT"},"link":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the URL and expiry of said URL the end customer needs to be directed to in order to go through Hosted KYC flow. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_CUSTOMER_INPUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"kycreviewredirecturlupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update redirect URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is called."},"children":[]}]}]}],"properties":{"value":{"type":"string","description":"The URL that the end customer needs to be directed to in order to go through the Hosted KYC flow.","example":"https://wise-sandbox.com/embedded-flows/verification?token=d7332edb-25bf-41af-a4e9-09f5efe39ded&checkId=3120073"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp for when the one-time token in the link will expire, after which a new link needs to be generated.","example":"2024-09-03T16:29:41.203225146"}}},"createdAt":{"type":"string","format":"date-time","description":"Timestamp marking the creation of the KYC Review.","example":"2024-09-03T16:22:02.257725"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp marking the last update of the KYC Review.","example":"2024-09-03T16:29:41.147522"},"requiredBy":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp by which the underlying requirement set needs to be verified to not block the customer. Only relevant if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-09-03T16:22:02.257725"},"triggerReferences":{"type":"array","description":"List of trigger reference objects.","items":{"type":"object","description":"An object that refers to the action or process this KYC Review pertains to.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action or process this KYC Review is for. Usually a reference to which product this KYC Review pertains to (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROACTIVE_SEND_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFO_REQUEST"},"children":[]}]}]}]}],"example":"QUOTE"},"triggerData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value object containing metadata of the underlying product object that triggered the KYC Review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that refers to their respective IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains a list of currencies (e.g. USD, SGD, EUR) that the bank details have been created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields and their data types for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerReference.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (uuid)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (long)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (long)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list of string)"},"children":[]}]}]}]}],"additionalProperties":true,"example":{"id":"ba83a43a-f623-46f0-956d-196c13e2ab01"}}}}},"redirectUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected at the end of the flow. Can contain query params and path fragments. It has to be a valid URL as per "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc2396.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 2396"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Provided by the caller in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"kycreviewredirecturlupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update redirect URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call."},"children":[]}]}]}],"example":"https://example.com"},"requirements":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[Requirement]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, where each inner list represents a combination of possible requirements to be provided. To fulfil the whole KYC Review, at least one item from each inner list should be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the requirements are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[a, b], [c, d]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it should be read as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(a or b) and (c or d)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/kyc-requirement"}}}}}},"components/schemas/client-credentials-grant":{"id":"components/schemas/client-credentials-grant","kind":"json-schema","title":"client-credentials-grant","data":{"type":"object","required":["grant_type"],"properties":{"grant_type":{"type":"string","description":"OAuth 2.0 grant type.","enum":["client_credentials"],"example":"client_credentials"}}}},"components/schemas/registration-code-grant":{"id":"components/schemas/registration-code-grant","kind":"json-schema","title":"registration-code-grant","data":{"type":"object","required":["grant_type","client_id","email","registration_code"],"properties":{"grant_type":{"type":"string","description":"OAuth 2.0 grant type.","enum":["registration_code"],"example":"registration_code"},"client_id":{"type":"string","description":"Your API client ID."},"email":{"type":"string","format":"email","description":"The email address of the user being registered."},"registration_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registration code obtained when creating the user via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/user/signup/registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/authorization-code-grant":{"id":"components/schemas/authorization-code-grant","kind":"json-schema","title":"authorization-code-grant","data":{"type":"object","required":["grant_type","client_id","code","redirect_uri"],"properties":{"grant_type":{"type":"string","description":"OAuth 2.0 grant type.","enum":["authorization_code"],"example":"authorization_code"},"client_id":{"type":"string","description":"Your API client ID."},"code":{"type":"string","description":"Authorisation code provided upon redirect back from the authorisation flow."},"redirect_uri":{"type":"string","description":"Registered redirect URL coordinated with Wise during onboarding.","example":"https://www.yourapp.com"}}}},"components/schemas/refresh-token-grant":{"id":"components/schemas/refresh-token-grant","kind":"json-schema","title":"refresh-token-grant","data":{"type":"object","required":["grant_type","refresh_token"],"properties":{"grant_type":{"type":"string","description":"OAuth 2.0 grant type.","enum":["refresh_token"],"example":"refresh_token"},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh token obtained from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant."},"children":[]}]}]}]}}}},"components/schemas/token-response":{"id":"components/schemas/token-response","kind":"json-schema","title":"token-response","data":{"type":"object","properties":{"access_token":{"type":"string","description":"Access token to be used when calling the API. Valid for 12 hours.","example":"01234567-89ab-cdef-0123-456789abcdef"},"token_type":{"type":"string","description":"Type of the token.","example":"bearer"},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh token used to obtain new user access tokens without requiring the user to re-authorise. Valid for up to 20 years."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned for user access token grant types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"01234567-89ab-cdef-0123-456789abcdef"},"expires_in":{"type":"integer","format":"int32","description":"Access token expiry time in seconds.","example":43199},"expires_at":{"type":"string","description":"Access token expiration timestamp (UTC).","example":"2025-04-11T03:43:28.148Z"},"refresh_token_expires_in":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh token expiry time in seconds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned for user access token grant types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":628639555},"refresh_token_expires_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh token expiration timestamp (UTC)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned for user access token grant types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2045-03-12T13:49:23.552Z"},"scope":{"type":"string","description":"Scope of the token.","example":"transfers"},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token creation time in ISO 8601 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only returned for user access token grant types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2020-01-01T12:33:33.12345Z"}}}},"components/schemas/phone-number":{"id":"components/schemas/phone-number","kind":"json-schema","title":"Phone Number","data":{"title":"Phone Number","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the phone number.","example":1230944},"phoneNumber":{"type":"string","description":"A text representation of phone number.","example":"+6588888888"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of phone number when used in authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIMARY"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at the moment."},"children":[]}]}]}],"example":"PRIMARY"},"verified":{"type":"boolean","description":"Indicator if phone number is verified.","example":true},"clientId":{"type":"string","description":"Client ID of which this phone number belongs to.","example":"clientId"}}}},"components/schemas/ott-response":{"id":"components/schemas/ott-response","kind":"json-schema","title":"ott-response","data":{"type":"object","properties":{"oneTimeTokenProperties":{"type":"object","description":"Properties of the one time token.","properties":{"oneTimeToken":{"type":"string","description":"Unique identifier of a one time token."},"challenges":{"type":"array","description":"Array of challenge objects.","items":{"type":"object","description":"Challenge object containing primary and alternative challenges.","properties":{"primaryChallenge":{"type":"object","description":"Type of challenge user can do.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the challenge (PIN, FACE_MAP, SMS, WHATSAPP, VOICE, PARTNER_DEVICE_FINGERPRINT)."},"children":[]}]}]}]},"viewData":{"type":"object","description":"An object that provides data required to present a challenge window. It can be messages, IDs, or other attributes."}}},"alternatives":{"type":"array","description":"Alternative challenges that user can do instead.","items":{"type":"object"}},"required":{"type":"boolean","description":"Required (or not) to pass the OTT."},"passed":{"type":"boolean","description":"Status of this challenge."}}}},"validity":{"type":"integer","format":"int64","description":"Seconds until the one time token becomes expired."},"actionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action bound to the one time token. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE__GET_STATEMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when we want to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/balance-statement/balancestatementget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve a balance account statement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"userId":{"type":"integer","format":"int64","description":"Creator of this one time token."}}}}}},"components/schemas/case":{"id":"components/schemas/case","kind":"json-schema","title":"case","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Case ID. Generated by Wise.","example":123456789},"status":{"type":"string","description":"Status of the case","enum":["CREATING","PENDING"],"example":"CREATING"},"type":{"type":"string","description":"Type of the case. More case types will be added in the future.","enum":["GENERAL_ENQUIRY"],"example":"GENERAL_ENQUIRY"},"externalId":{"type":"string","description":"An ID provided by the external partner for partner internal tracking.","example":"partner_12344567"},"createdAt":{"type":"string","format":"date-time","description":"When the case was originally created.","example":"2023-06-28T15:21:24.901"},"updatedAt":{"type":"string","format":"date-time","description":"When the case was last updated.","example":"2023-06-28T15:21:24.901"}}}},"components/schemas/content-attributes":{"id":"components/schemas/content-attributes","kind":"json-schema","title":"Attributes Content (REQUEST messages)","data":{"type":"object","title":"Attributes Content (REQUEST messages)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content structure for REQUEST messages (e.g., DEPOSIT_SANCTION_HIT_REQUEST)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains dynamic attributes that define what information is required from the partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attributes object contains ALL possible entity types for the case subtype."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner should submit data for ONE of the entity types."},"children":[]}]}]}],"properties":{"attributes":{"type":"object","description":"Dynamic attributes defining required information for each entity type.","properties":{"individual":{"type":"object","description":"Attributes for individual entity type.","properties":{"name":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":true}}},"dob":{"type":"object","properties":{"type":{"type":"string","example":"LocalDate"},"required":{"type":"boolean","example":false}}},"countryOfResidenceIso3":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":false}}},"nationality":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":false}}}}},"business":{"type":"object","description":"Attributes for business/organisation entity type.","properties":{"name":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":true}}},"address":{"type":"object","properties":{"type":{"type":"string","example":"Address"},"required":{"type":"boolean","example":true}}},"natureOfBusiness":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":false}}},"website":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":false}}}}},"vessel":{"type":"object","description":"Attributes for vessel entity type.","properties":{"imoNumber":{"type":"object","properties":{"type":{"type":"string","example":"String"},"required":{"type":"boolean","example":true}}}}},"other":{"type":"object","description":"Attributes for other entity type or location hit.","additionalProperties":true}}}},"required":["attributes"],"example":{"attributes":{"business":{"name":{"type":"String","required":true},"address":{"type":"Address","required":true},"natureOfBusiness":{"type":"String","required":false},"website":{"type":"String","required":false}},"vessel":{"imoNumber":{"type":"String","required":true}},"other":{"explanation":{"type":"String","required":true}},"individual":{"name":{"type":"String","required":true},"dob":{"type":"LocalDate","required":false},"countryOfResidenceIso3":{"type":"String","required":false},"nationality":{"type":"String","required":false}}}}}},"components/schemas/content-submission-data":{"id":"components/schemas/content-submission-data","kind":"json-schema","title":"Submission Data Content (SUBMISSION messages)","data":{"type":"object","title":"Submission Data Content (SUBMISSION messages)","description":"Content structure for SUBMISSION messages containing partner-submitted data.","properties":{"submissionData":{"type":"object","description":"The data submitted by the partner. Contains ONE entity type.","oneOf":[{"title":"Individual submission","type":"object","properties":{"individual":{"type":"object","properties":{"name":{"type":"string","example":"Mr. Robert Downy Junior"},"dob":{"type":"string","example":"1985-03-15"},"countryOfResidenceIso3":{"type":"string","example":"GBR"},"nationality":{"type":"string","example":"British"}},"required":["name"]}}},{"title":"Organisation submission","type":"object","properties":{"organisation":{"type":"object","properties":{"name":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"postCode":{"type":"string"},"countryIso3":{"type":"string"},"natureOfBusiness":{"type":"string"},"website":{"type":"string"}},"required":["name","streetAddress","city","postCode","countryIso3"]}}},{"title":"Vessel submission","type":"object","properties":{"vessel":{"type":"object","properties":{"vesselImoNumber":{"type":"string","example":"9074729"}},"required":["vesselImoNumber"]}}},{"title":"Multiple submission","type":"object","properties":{"multiple":{"type":"object","properties":{"explanation":{"type":"string"}},"required":["explanation"]}}},{"title":"Other/Location submission","type":"object","properties":{"other":{"type":"object","additionalProperties":true}}}]}},"required":["submissionData"],"example":{"submissionData":{"individual":{"name":"Mr. Robert Downy Junior","countryOfResidenceIso3":"GBR"}}}}},"components/schemas/content-text":{"id":"components/schemas/content-text","kind":"json-schema","title":"Text Content (FREEFORM messages)","data":{"type":"object","title":"Text Content (FREEFORM messages)","description":"Content structure for FREEFORM messages containing free text conversation.","properties":{"text":{"type":"object","description":"Text content object.","properties":{"freeText":{"type":"string","description":"The free text message content.","example":"Thank you for the submission. We have reviewed the information."}},"required":["freeText"]}},"required":["text"],"example":{"text":{"freeText":"Please find the requested identity documents attached."}}}},"components/schemas/case-message-content":{"id":"components/schemas/case-message-content","kind":"json-schema","title":"case-message-content","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of a case message. The structure varies based on the message type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Present in *_REQUEST messages. Contains dynamic attributes defining required information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submissionData"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Present in *_SUBMISSION messages. Contains partner-submitted data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Present in FREEFORM messages. Contains free text conversation."},"children":[]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/content-attributes"},{"$ref":"#/components/schemas/content-submission-data"},{"$ref":"#/components/schemas/content-text"}]}},"components/schemas/case-message-author":{"id":"components/schemas/case-message-author","kind":"json-schema","title":"case-message-author","data":{"type":"string","description":"The author of the case message.","enum":["WISE_SYSTEM","PARTNER","WISE_AGENT"],"example":"PARTNER"}},"components/schemas/case-message":{"id":"components/schemas/case-message","kind":"json-schema","title":"case-message","data":{"type":"object","description":"A message within a support case.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the message (UUID v4).","minLength":36,"maxLength":36,"example":"67631430-77fd-4bbb-a8e0-fdfa67563d66"},"caseId":{"type":"integer","format":"int64","description":"The ID of the case this message belongs to.","example":485},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the message was created.\nFormat: ISO 8601 datetime without timezone (YYYY-MM-DDTHH:mm:ss.SSS).\n","example":"2026-07-29T16:06:06.014"},"content":{"$ref":"#/components/schemas/case-message-content"},"type":{"type":"string","description":"The type of the case message.","maxLength":128,"enum":["FREEFORM","RECIPIENT_LOCATION_HIT_REQUEST","REFERENCE_LOCATION_HIT_REQUEST","RECIPIENT_SANCTION_HIT_REQUEST","REFERENCE_SANCTION_HIT_REQUEST","DEPOSIT_SANCTION_HIT_REQUEST","DEPOSIT_SANCTION_HIT_SUBMISSION","REFERENCE_SANCTION_HIT_SUBMISSION","RECIPIENT_SANCTION_HIT_SUBMISSION","REFERENCE_LOCATION_HIT_SUBMISSION","RECIPIENT_LOCATION_HIT_SUBMISSION"],"example":"REFERENCE_SANCTION_HIT_REQUEST"},"author":{"$ref":"#/components/schemas/case-message-author"}},"required":["id","caseId","createdAt","content","type","author"]}},"components/schemas/case-2":{"id":"components/schemas/case-2","kind":"json-schema","title":"case-2","data":{"type":"object","description":"A support case with its complete details including messages and references.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier of the case.","example":485},"profileId":{"type":"integer","format":"int64","description":"The profile ID associated with this case.","example":220002553},"type":{"type":"string","description":"The type of the support case.","maxLength":255,"enum":["SANCTIONS","GENERAL_ENQUIRY"],"example":"SANCTIONS"},"subType":{"type":"string","description":"The sub-type of the support case.","maxLength":128,"enum":["RECIPIENT_LOCATION_HIT","REFERENCE_LOCATION_HIT","RECIPIENT_SANCTION_HIT","REFERENCE_SANCTION_HIT","DEPOSIT_SANCTION_HIT"],"example":"REFERENCE_SANCTION_HIT"},"status":{"type":"string","description":"The current status of the support case.","maxLength":255,"enum":["CREATING","IN_REVIEW","WAITING_CUSTOMER_INPUT","RESOLVED","FAILED"],"example":"IN_REVIEW"},"externalId":{"type":"string","description":"Partner-created identifier for this case, if applicable.","maxLength":255,"example":"PARTNER-CASE-001"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the case was created.\nFormat: ISO 8601 datetime without timezone (YYYY-MM-DDTHH:mm:ss.SSS).\n","example":"2026-07-29T16:06:06.003"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the case was last updated.\nFormat: ISO 8601 datetime without timezone (YYYY-MM-DDTHH:mm:ss.SSS).\n","example":"2026-07-29T16:09:32.998"},"reference":{"type":"object","description":"Reference information linking the case to a related entity.","properties":{"type":{"type":"string","maxLength":128,"enum":["TRANSFER"],"example":"TRANSFER"},"referenceId":{"type":"string","maxLength":128,"example":"2147513101"}},"required":["type","referenceId"]},"messages":{"type":"array","description":"List of messages associated with this case.","items":{"$ref":"#/components/schemas/case-message"}}},"required":["id","profileId","type","status","createdAt","messages"]}},"components/schemas/validation-error":{"id":"components/schemas/validation-error","kind":"json-schema","title":"Validation Error","data":{"type":"object","title":"Validation Error","description":"Details about a specific field validation error.","properties":{"field":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field path that caused the validation error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uses dot notation for nested fields (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionData.individual.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"type"},"message":{"type":"string","description":"Description of what validation rule was violated.","example":"must not be null"},"rejectedValue":{"description":"The value that was rejected (if applicable).","example":null}},"required":["field","message"],"example":{"field":"submissionData.individual.name","message":"must not be blank","rejectedValue":""}}},"components/schemas/error-response":{"id":"components/schemas/error-response","kind":"json-schema","title":"Error Response","data":{"type":"object","title":"Error Response","description":"Standard error response structure returned by the API.\n\nAll error responses follow this consistent format with an error code,\nhuman-readable message, and optional validation errors array.\n","properties":{"error":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code indicating the type of error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common codes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BAD_REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid request format or parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALIDATION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Request body validation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Requested resource does not exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAUTHORIZED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Authentication required or failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORBIDDEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Insufficient permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Operation conflicts with current state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_SERVER_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unexpected server error"},"children":[]}]}]}]}],"example":"BAD_REQUEST"},"message":{"type":"string","description":"Human-readable error message describing what went wrong.","example":"Invalid request body"},"timestamp":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the error occurred.","example":"2026-08-03T10:30:00.000Z"},"path":{"type":"string","description":"The request path that caused the error.","example":"/public/2026Q3/v2/cases/12345678"},"errors":{"type":"array","description":"List of field-level validation errors.\nOnly present for validation errors (HTTP 400).\n","items":{"$ref":"#/components/schemas/validation-error"}}},"required":["error","message"]}},"components/schemas/error-400-bad-request":{"id":"components/schemas/error-400-bad-request","kind":"json-schema","title":"error-400-bad-request","data":{"allOf":[{"$ref":"#/components/schemas/error-response"},{"type":"object","title":"Bad Request Error (400)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the request is malformed or contains invalid data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing required fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid enum values for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Malformed JSON in request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid field values that fail validation"},"children":[]}]}]}]}],"properties":{"error":{"example":"BAD_REQUEST"},"message":{"example":"Invalid request body"}},"example":{"error":"BAD_REQUEST","message":"Validation failed for request body","timestamp":"2026-08-03T10:30:00.000Z","path":"/public/2026Q3/v2/cases/12345678/messages","errors":[{"field":"type","message":"must not be null"},{"field":"submissionData","message":"must not be null"}]}}]}},"components/schemas/error-401-unauthorized":{"id":"components/schemas/error-401-unauthorized","kind":"json-schema","title":"error-401-unauthorized","data":{"allOf":[{"$ref":"#/components/schemas/error-response"},{"type":"object","title":"Unauthorized Error (401)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when authentication is missing or invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or expired API token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Malformed authorization header format"},"children":[]}]}]}]}],"properties":{"error":{"example":"UNAUTHORIZED"},"message":{"example":"Authentication required"}},"example":{"error":"UNAUTHORIZED","message":"Invalid or missing authentication credentials","timestamp":"2026-08-03T10:30:00.000Z","path":"/public/2026Q3/v2/cases/12345678"}}]}},"components/schemas/error-403-forbidden":{"id":"components/schemas/error-403-forbidden","kind":"json-schema","title":"error-403-forbidden","data":{"allOf":[{"$ref":"#/components/schemas/error-response"},{"type":"object","title":"Forbidden Error (403)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the authenticated client lacks permission to access the resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case belongs to a different partner (client key mismatch)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempting to access a case type not permitted for this client"},"children":[]}]}]}]}],"properties":{"error":{"example":"FORBIDDEN"},"message":{"example":"Access denied"}},"example":{"error":"FORBIDDEN","message":"You do not have permission to access this resource","timestamp":"2026-08-03T10:30:00.000Z","path":"/public/2026Q3/v2/cases/12345678"}}]}},"components/schemas/error-404-not-found":{"id":"components/schemas/error-404-not-found","kind":"json-schema","title":"error-404-not-found","data":{"allOf":[{"$ref":"#/components/schemas/error-response"},{"type":"object","title":"Not Found Error (404)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the requested case does not exist."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"caseId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case was deleted or archived"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typo in the case ID"},"children":[]}]}]}]}],"properties":{"error":{"example":"RESOURCE_NOT_FOUND"},"message":{"example":"Case not found"}},"example":{"error":"RESOURCE_NOT_FOUND","message":"Case with id 99999999 not found","timestamp":"2026-08-03T10:30:00.000Z","path":"/public/2026Q3/v2/cases/99999999"}}]}},"components/schemas/message-submission-type":{"id":"components/schemas/message-submission-type","kind":"json-schema","title":"message-submission-type","data":{"type":"string","description":"The type of message submission.","enum":["FREEFORM","DEPOSIT_SANCTION_HIT_SUBMISSION","REFERENCE_SANCTION_HIT_SUBMISSION","RECIPIENT_SANCTION_HIT_SUBMISSION","REFERENCE_LOCATION_HIT_SUBMISSION","RECIPIENT_LOCATION_HIT_SUBMISSION"],"example":"FREEFORM"}},"components/schemas/submission-data-freeform":{"id":"components/schemas/submission-data-freeform","kind":"json-schema","title":"FREEFORM Submission Data","data":{"type":"object","title":"FREEFORM Submission Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for FREEFORM message type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for general text-based communication on a case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case must not be in RESOLVED or FAILED status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED and must be non-blank"},"children":[]}]}]}]}],"properties":{"freeText":{"type":"string","description":"The free-form text message to submit.\nCan include additional context, questions, or documentation references.\n","minLength":1,"maxLength":10000,"example":"The transfer has been verified and approved by our compliance team."}},"required":["freeText"],"example":{"freeText":"Please find attached the requested documentation for this transfer."}}},"components/schemas/submission-individual":{"id":"components/schemas/submission-individual","kind":"json-schema","title":"Individual Submission","data":{"type":"object","title":"Individual Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for an individual entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED for all individual submissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryOfResidenceIso3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED for:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECIPIENT_SANCTION_HIT_SUBMISSION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REFERENCE_SANCTION_HIT_SUBMISSION"},"children":[]}]}]}]}]}]}],"properties":{"individual":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the individual.","minLength":1,"maxLength":255,"example":"John Doe"},"countryOfResidenceIso3":{"type":"string","description":"ISO 3166-1 alpha-3 country code for country of residence.\nREQUIRED for RECIPIENT and REFERENCE sanction hit submissions.\n","minLength":3,"maxLength":3,"example":"GBR"},"dob":{"type":"string","description":"Date of birth.\nAccepted formats: DD/MM/YYYY or YYYY-MM-DD\n","maxLength":10,"example":"15/03/1985"},"nationality":{"type":"string","description":"Nationality of the individual.","maxLength":100,"example":"British"}},"required":["name"]}},"required":["individual"],"example":{"individual":{"name":"John Doe","countryOfResidenceIso3":"GBR","dob":"15/03/1985","nationality":"British"}}}},"components/schemas/submission-organisation":{"id":"components/schemas/submission-organisation","kind":"json-schema","title":"Organisation Submission","data":{"type":"object","title":"Organisation Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for an organisation entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields marked as required must be non-blank strings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryIso3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a valid ISO 3166-1 alpha-3 country code"},"children":[]}]}]}]}],"properties":{"organisation":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organisation.","minLength":1,"maxLength":255,"example":"Acme Corporation Ltd"},"streetAddress":{"type":"string","description":"Street address of the organisation.","minLength":1,"maxLength":500,"example":"123 Business Park"},"city":{"type":"string","description":"City where the organisation is located.","minLength":1,"maxLength":100,"example":"London"},"postCode":{"type":"string","description":"Postal code of the organisation's address.","minLength":1,"maxLength":20,"example":"EC1A 1BB"},"countryIso3":{"type":"string","description":"ISO 3166-1 alpha-3 country code.","minLength":3,"maxLength":3,"example":"GBR"},"natureOfBusiness":{"type":"string","description":"Description of the organisation's business activities.","maxLength":500,"example":"Financial Services"},"website":{"type":"string","description":"Organisation's website URL.","format":"uri","maxLength":500,"example":"https://www.acme-corp.com"}},"required":["name","streetAddress","city","postCode","countryIso3"]}},"required":["organisation"],"example":{"organisation":{"name":"Acme Corporation Ltd","streetAddress":"123 Business Park","city":"London","postCode":"EC1A 1BB","countryIso3":"GBR","natureOfBusiness":"Financial Services","website":"https://www.acme-corp.com"}}}},"components/schemas/submission-vessel":{"id":"components/schemas/submission-vessel","kind":"json-schema","title":"Vessel Submission","data":{"type":"object","title":"Vessel Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for a vessel entity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for REFERENCE_SANCTION_HIT_SUBMISSION."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vesselImoNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED and must be non-blank"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMO numbers are 7-digit identifiers issued by the International Maritime Organization"},"children":[]}]}]}]}],"properties":{"vessel":{"type":"object","properties":{"vesselImoNumber":{"type":"string","description":"International Maritime Organization (IMO) number of the vessel.\nIMO numbers are 7 digits, sometimes prefixed with \"IMO\".\n","minLength":1,"maxLength":20,"example":"9074729"}},"required":["vesselImoNumber"]}},"required":["vessel"],"example":{"vessel":{"vesselImoNumber":"9074729"}}}},"components/schemas/submission-multiple":{"id":"components/schemas/submission-multiple","kind":"json-schema","title":"Multiple Submission","data":{"type":"object","title":"Multiple Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data when multiple entities are involved."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for REFERENCE_SANCTION_HIT_SUBMISSION."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"explanation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED and must be non-blank"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide clear details about all entities involved"},"children":[]}]}]}]}],"properties":{"multiple":{"type":"object","properties":{"explanation":{"type":"string","description":"Explanation describing the multiple entities involved.\nShould include details about all parties and their relationship.\n","minLength":1,"maxLength":2000,"example":"Transfer involves multiple beneficiaries as part of a group payment arrangement."}},"required":["explanation"]}},"required":["multiple"],"example":{"multiple":{"explanation":"Transfer involves multiple beneficiaries as part of a group payment arrangement for a consortium project."}}}},"components/schemas/submission-other":{"id":"components/schemas/submission-other","kind":"json-schema","title":"Other Submission","data":{"type":"object","title":"Other Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for other entity types not covered by standard categories."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only valid for REFERENCE_SANCTION_HIT_SUBMISSION."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"explanation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED and must be non-blank"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use when the entity doesn't fit individual, organisation, vessel, or multiple categories"},"children":[]}]}]}]}],"properties":{"other":{"type":"object","properties":{"explanation":{"type":"string","description":"Free-form explanation for the entity.\nDescribe the entity type and relevant details.\n","minLength":1,"maxLength":2000,"example":"This is a government entity that does not fit standard categories."}},"required":["explanation"]}},"required":["other"],"example":{"other":{"explanation":"This is a government entity that does not fit standard categories. It is the Ministry of Commerce."}}}},"components/schemas/submission-data-sanction-hit":{"id":"components/schemas/submission-data-sanction-hit","kind":"json-schema","title":"Sanction Hit Submission Data","data":{"type":"object","title":"Sanction Hit Submission Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for sanction hit cases. Used for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPOSIT_SANCTION_HIT_SUBMISSION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REFERENCE_SANCTION_HIT_SUBMISSION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECIPIENT_SANCTION_HIT_SUBMISSION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only ONE of the entity types should be provided per submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules by Submission Type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPOSIT_SANCTION_HIT_SUBMISSION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exactly one)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECIPIENT_SANCTION_HIT_SUBMISSION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exactly one)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryOfResidenceIso3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REFERENCE_SANCTION_HIT_SUBMISSION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain exactly one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multiple"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vessel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryOfResidenceIso3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is REQUIRED"},"children":[]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/submission-individual"},{"$ref":"#/components/schemas/submission-organisation"},{"$ref":"#/components/schemas/submission-vessel"},{"$ref":"#/components/schemas/submission-multiple"},{"$ref":"#/components/schemas/submission-other"}]}},"components/schemas/submission-reference-location":{"id":"components/schemas/submission-reference-location","kind":"json-schema","title":"Reference Location Hit Submission","data":{"type":"object","title":"Reference Location Hit Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for REFERENCE_LOCATION_HIT_SUBMISSION."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when a payment reference triggers a location-based compliance check."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are REQUIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All required fields must be non-blank strings"},"children":[]}]}]}]}],"properties":{"other":{"type":"object","properties":{"relatedToLocation":{"type":"string","description":"Explanation of how the reference is related to the flagged location.","minLength":1,"maxLength":2000,"example":"Payment reference mentions a supplier in Belarus."},"paymentExplanation":{"type":"string","description":"Explanation of the purpose of the payment.","minLength":1,"maxLength":2000,"example":"Payment for agricultural equipment parts."},"location":{"type":"string","description":"The specific location being addressed.","minLength":1,"maxLength":255,"example":"Minsk, Belarus"},"referenceDescription":{"type":"string","description":"Description of the payment reference that triggered the location hit.","minLength":1,"maxLength":2000,"example":"Invoice INV-2026-001 for tractor parts shipped from Minsk warehouse."}},"required":["relatedToLocation","paymentExplanation","location","referenceDescription"]}},"required":["other"],"example":{"other":{"relatedToLocation":"Payment reference mentions a supplier in Belarus.","paymentExplanation":"Payment for agricultural equipment parts from authorised supplier.","location":"Minsk, Belarus","referenceDescription":"Invoice INV-2026-001 for tractor parts shipped from Minsk warehouse."}}}},"components/schemas/submission-recipient-location":{"id":"components/schemas/submission-recipient-location","kind":"json-schema","title":"Recipient Location Hit Submission","data":{"type":"object","title":"Recipient Location Hit Submission","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for RECIPIENT_LOCATION_HIT_SUBMISSION."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when a recipient's location triggers a compliance check."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rules:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedToLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentExplanation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are REQUIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessWebsite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All required fields must be non-blank strings"},"children":[]}]}]}]}],"properties":{"other":{"type":"object","properties":{"relatedToLocation":{"type":"string","description":"Explanation of how the recipient is related to the flagged location.","minLength":1,"maxLength":2000,"example":"Recipient has a registered business address in the location."},"paymentExplanation":{"type":"string","description":"Explanation of the purpose of the payment.","minLength":1,"maxLength":2000,"example":"Payment for software development services."},"location":{"type":"string","description":"The specific location being addressed.","minLength":1,"maxLength":255,"example":"Suspicous City, Country"},"businessWebsite":{"type":"string","description":"Website of the recipient's business (optional).","format":"uri","maxLength":500,"example":"https://www.techcorp-global.com"}},"required":["relatedToLocation","paymentExplanation","location"]}},"required":["other"],"example":{"other":{"relatedToLocation":"Recipient has a registered branch office in the flagged location.","paymentExplanation":"Payment for software development services rendered under contract.","location":"Suspicous City, Country","businessWebsite":"https://www.techcorp-global.com"}}}},"components/schemas/submission-data-location-hit":{"id":"components/schemas/submission-data-location-hit","kind":"json-schema","title":"Location Hit Submission Data","data":{"type":"object","title":"Location Hit Submission Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission data for location hit cases. Used for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REFERENCE_LOCATION_HIT_SUBMISSION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECIPIENT_LOCATION_HIT_SUBMISSION"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both types require an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with location-specific details."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/submission-reference-location"},{"$ref":"#/components/schemas/submission-recipient-location"}]}},"components/schemas/message-submission-request":{"id":"components/schemas/message-submission-request","kind":"json-schema","title":"message-submission-request","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for submitting a message to a case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The structure of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"properties":{"type":{"$ref":"#/components/schemas/message-submission-type"},"submissionData":{"type":"object","description":"The data for the message submission. Structure varies based on submission type.\n","oneOf":[{"$ref":"#/components/schemas/submission-data-freeform"},{"$ref":"#/components/schemas/submission-data-sanction-hit"},{"$ref":"#/components/schemas/submission-data-location-hit"}]}},"required":["type","submissionData"]}},"components/schemas/message-submission-response":{"id":"components/schemas/message-submission-response","kind":"json-schema","title":"message-submission-response","data":{"type":"object","description":"Response returned after successfully submitting a message.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the created message (UUID v4).","minLength":36,"maxLength":36,"example":"660e8400-e29b-41d4-a716-446655440001"},"caseId":{"type":"integer","format":"int64","description":"The ID of the case this message belongs to.","example":12345678},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the message was created.\nFormat: ISO 8601 datetime without timezone (server timezone is UTC).\n","example":"2026-07-27T15:00:00.000"},"content":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the created message."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For FREEFORM: contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text.freeText"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For SUBMISSION types: contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionData"},"children":[]}]}]}]}],"additionalProperties":true},"type":{"type":"string","description":"The type of the created message.","enum":["FREEFORM","DEPOSIT_SANCTION_HIT_SUBMISSION","REFERENCE_SANCTION_HIT_SUBMISSION","RECIPIENT_SANCTION_HIT_SUBMISSION","REFERENCE_LOCATION_HIT_SUBMISSION","RECIPIENT_LOCATION_HIT_SUBMISSION"],"example":"FREEFORM"},"author":{"type":"string","description":"The author of the message (always PARTNER for submitted messages).","enum":["PARTNER"],"example":"PARTNER"}},"required":["id","caseId","createdAt","content","type","author"]}},"components/schemas/error-422-unprocessable-entity":{"id":"components/schemas/error-422-unprocessable-entity","kind":"json-schema","title":"error-422-unprocessable-entity","data":{"allOf":[{"$ref":"#/components/schemas/error-response"},{"type":"object","title":"Unprocessable Entity Error (422)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the request is syntactically correct but semantically invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission type does not match case sub-type (e.g., submitting DEPOSIT_SANCTION_HIT_SUBMISSION for a RECIPIENT_SANCTION_HIT case)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing required fields for the submission type (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countryOfResidenceIso3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" missing for RECIPIENT sanction hit individual)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"individual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" AND "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when only one is allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid ISO country code format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid date format for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]}]}]}]}],"properties":{"error":{"example":"UNPROCESSABLE_ENTITY"},"message":{"example":"Submission type mismatch"}},"example":{"error":"UNPROCESSABLE_ENTITY","message":"Submission type DEPOSIT_SANCTION_HIT_SUBMISSION is not valid for case sub-type RECIPIENT_SANCTION_HIT","timestamp":"2026-08-03T10:30:00.000Z","path":"/public/2026Q3/v2/cases/12345678/messages"}}]}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"address","data":{"type":"object","description":"Address associated with a profile.","properties":{"id":{"type":"integer","format":"int64","description":"ID of the address.","example":36086782},"addressFirstLine":{"type":"string","description":"First line of the address.","example":"24 Willow Creek Lane"},"city":{"type":"string","description":"City of the address.","example":"Bristol"},"countryIso2Code":{"type":"string","description":"Two-letter ISO country code.","example":"GB"},"countryIso3Code":{"type":"string","description":"Three-letter ISO country code.","example":"gbr"},"postCode":{"type":"string","description":"Postal code of the address.","example":"BS1 6AE"},"stateCode":{"type":["string","null"],"description":"State code of the address (can be null for some countries).","example":null}}}},"components/schemas/personal-profile":{"id":"components/schemas/personal-profile","kind":"json-schema","title":"Personal Profile","data":{"title":"Personal Profile","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of profile.","enum":["PERSONAL"],"example":"PERSONAL"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the profile.","example":14575282},"publicId":{"type":"string","description":"Publicly accessible identifier for the profile.","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"userId":{"type":"integer","format":"int64","description":"The ID of the user associated with this profile.","example":9889627},"address":{"description":"Main registered address of the profile.","$ref":"#/components/schemas/address"},"email":{"type":"string","description":"Primary email address for the profile.","example":"sarah.jenkins@example.com"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was created (ISO 8601 format).","example":"2023-01-15T10:30:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was last updated (ISO 8601 format).","example":"2025-06-18T14:20:00"},"avatar":{"type":["string","null"],"description":"Link to person avatar image.","example":null},"currentState":{"type":"string","description":"Current status of this profile.","enum":["HIDDEN","VISIBLE","DEACTIVATED"],"example":"VISIBLE"},"contactDetails":{"type":"object","description":"Contact information for the profile.","properties":{"email":{"type":"string","description":"Contact email address.","example":"sarah.contact@example.com"},"phoneNumber":{"type":"string","description":"Contact phone number.","example":"+447700900123"}}},"firstName":{"type":"string","description":"First name of the profile holder.","example":"Sarah"},"lastName":{"type":"string","description":"Last name of the profile holder.","example":"Jenkins"},"preferredName":{"type":"string","description":"Preferred name of the profile holder.","example":"Sal"},"dateOfBirth":{"type":"string","description":"Date of birth of the profile holder.","example":"1985-05-20"},"phoneNumber":{"type":"string","description":"Phone number of the profile holder.","example":"+447700900456"},"secondaryAddresses":{"type":"array","description":"An array of secondary addresses associated with the profile.","items":{"$ref":"#/components/schemas/address"}},"fullName":{"type":"string","description":"Full name of the profile holder.","example":"Sarah Jenkins"}}}},"components/schemas/business-profile":{"id":"components/schemas/business-profile","kind":"json-schema","title":"Business Profile","data":{"title":"Business Profile","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of profile.","enum":["BUSINESS"],"example":"BUSINESS"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the profile.","example":14599371},"publicId":{"type":"string","description":"Publicly accessible identifier for the profile.","example":"f0e9d8c7-b6a5-4321-fedc-ba9876543210"},"userId":{"type":"integer","format":"int64","description":"The ID of the user associated with this profile.","example":9889627},"address":{"description":"Main registered address of the business.","$ref":"#/components/schemas/address"},"email":{"type":"string","description":"Primary email address for the business.","example":"info@innovate-solutions.co.uk"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was created (ISO 8601 format).","example":"2024-03-10T09:00:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was last updated (ISO 8601 format).","example":"2025-06-18T14:22:00"},"currentState":{"type":"string","description":"Current status of this profile.","enum":["HIDDEN","VISIBLE","DEACTIVATED"],"example":"VISIBLE"},"contactDetails":{"type":"object","description":"Contact information for the business.","properties":{"email":{"type":"string","description":"Contact email address.","example":"contact@innovate-solutions.co.uk"},"phoneNumber":{"type":"string","description":"Contact phone number.","example":"+441617891234"}}},"businessName":{"type":"string","description":"Registered business name.","example":"Innovate Solutions Ltd"},"registrationNumber":{"type":"string","description":"Business registration number.","example":"SC1234567890ABCD"},"descriptionOfBusiness":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. New integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"industryCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/migrate-business-profile-industry-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migrating to industry categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IT_DEVELOPMENT"},"webpage":{"type":"string","description":"Business website URL.","example":"https://www.innovate-solutions.co.uk"},"companyType":{"type":"string","description":"Type of company.","example":"LIMITED_COMPANY"},"companyRole":{"type":"string","description":"Role of the person managing the business profile.","enum":["OWNER","DIRECTOR","OTHER"],"example":"OWNER"},"businessFreeFormDescription":{"type":"string","description":"Free-form description of the business activities.","example":"We create cutting-edge software for businesses."},"firstLevelCategory":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. New integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"industryCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/migrate-business-profile-industry-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migrating to industry categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CONSULTING_IT_BUSINESS_SERVICES"},"secondLevelCategory":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. New integrations should use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"industryCategories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/migrate-business-profile-industry-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migrating to industry categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IT_DEVELOPMENT"},"industryCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more industry categories classifying the business. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of valid values."},"children":[]}]}]}],"items":{"type":"string"},"example":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"]},"operationalAddresses":{"type":"array","description":"An array of operational addresses for the business.","items":{"$ref":"#/components/schemas/address"}},"fullName":{"type":"string","description":"Full legal name of the business.","example":"Innovate Solutions Ltd"}}}},"components/schemas/profile":{"id":"components/schemas/profile","kind":"json-schema","title":"Profile","data":{"title":"Profile","x-tags":["profile"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A profile represents an identity that can send and receive money through Wise. There are two types: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (an individual) and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (a company). The fields returned vary depending on the profile type."},"children":[]}]}]}],"discriminator":{"propertyName":"type","mapping":{"PERSONAL":"#/components/schemas/personal-profile","BUSINESS":"#/components/schemas/business-profile"}},"oneOf":[{"$ref":"#/components/schemas/personal-profile"},{"$ref":"#/components/schemas/business-profile"}]}},"components/schemas/business-profile-industry-categories":{"id":"components/schemas/business-profile-industry-categories","kind":"json-schema","title":"Business Profile","data":{"title":"Business Profile","type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of profile.","enum":["BUSINESS"],"example":"BUSINESS"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the profile.","example":14599371},"publicId":{"type":"string","description":"Publicly accessible identifier for the profile.","example":"f0e9d8c7-b6a5-4321-fedc-ba9876543210"},"userId":{"type":"integer","format":"int64","description":"The ID of the user associated with this profile.","example":9889627},"address":{"description":"Main registered address of the business.","$ref":"#/components/schemas/address"},"email":{"type":"string","description":"Primary email address for the business.","example":"info@innovate-solutions.co.uk"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was created (ISO 8601 format).","example":"2024-03-10T09:00:00"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the profile was last updated (ISO 8601 format).","example":"2025-06-18T14:22:00"},"currentState":{"type":"string","description":"Current status of this profile.","enum":["HIDDEN","VISIBLE","DEACTIVATED"],"example":"VISIBLE"},"contactDetails":{"type":"object","description":"Contact information for the business.","properties":{"email":{"type":"string","description":"Contact email address.","example":"contact@innovate-solutions.co.uk"},"phoneNumber":{"type":"string","description":"Contact phone number.","example":"+441617891234"}}},"businessName":{"type":"string","description":"Registered business name.","example":"Innovate Solutions Ltd"},"registrationNumber":{"type":"string","description":"Business registration number.","example":"SC1234567890ABCD"},"webpage":{"type":"string","description":"Business website URL.","example":"https://www.innovate-solutions.co.uk"},"companyType":{"type":"string","description":"Type of company.","example":"LIMITED_COMPANY"},"companyRole":{"type":"string","description":"Role of the person managing the business profile.","enum":["OWNER","DIRECTOR","OTHER"],"example":"OWNER"},"businessFreeFormDescription":{"type":"string","description":"Free-form description of the business activities.","example":"We create cutting-edge software for businesses."},"industryCategories":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more industry categories classifying the business. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of valid values."},"children":[]}]}]}],"items":{"type":"string"},"example":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"]},"operationalAddresses":{"type":"array","description":"An array of operational addresses for the business.","items":{"$ref":"#/components/schemas/address"}},"fullName":{"type":"string","description":"Full legal name of the business.","example":"Innovate Solutions Ltd"}}}},"components/schemas/director":{"id":"components/schemas/director","kind":"json-schema","title":"director","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the director. Automatically set.","example":10},"firstName":{"type":"string","description":"Director first name.","example":"John"},"lastName":{"type":"string","description":"Director last name.","example":"Doe"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1982-05-20"},"countryOfResidenceIso3Code":{"type":"string","description":"3 character country code.","example":"usa"}}}},"components/schemas/ubo":{"id":"components/schemas/ubo","kind":"json-schema","title":"ubo","data":{"type":"object","properties":{"id":{"type":"string","description":"ID of the ultimate beneficial owner.","example":"013ab1c2688d0185b582ee7e0bcb28b2"},"name":{"type":"string","description":"Owner full name.","example":"John Doe"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1982-05-20"},"countryOfResidenceIso3Code":{"type":"string","description":"3 character country code.","example":"usa"},"addressFirstLine":{"type":"string","description":"First line of address.","example":"123 Fake St"},"postCode":{"type":"string","description":"Address post code.","example":"FK 12345"},"ownershipPercentage":{"type":["integer","null"],"format":"int32","description":"Percentage of ownership.","example":30}}}},"components/schemas/quote":{"id":"components/schemas/quote","kind":"json-schema","title":"Quote","data":{"type":"object","title":"Quote","x-tags":["quote"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of this quote (GUID format).","example":"11144c35-9fe8-4c32-b7fd-d05c2a7734bf"},"sourceCurrency":{"type":"string","description":"Source (sending) currency code.","example":"GBP"},"targetCurrency":{"type":"string","description":"Target (receive) currency code.","example":"USD"},"sourceAmount":{"type":"number","description":"Amount in source currency to send.","example":100},"targetAmount":{"type":"number","description":"Amount in target currency to be received by the recipient.","example":129.24},"payOut":{"type":"string","description":"Mechanism Wise uses to deliver the transfer. Provided for information purposes.","example":"BANK_TRANSFER"},"preferredPayIn":{"type":"string","description":"Preferred pay-in method.","example":"BANK_TRANSFER"},"rate":{"type":"number","description":"Exchange rate value used for the conversion.","example":1.30445},"createdTime":{"type":"string","format":"date-time","description":"Quote created timestamp.","example":"2019-04-05T13:18:58Z"},"user":{"type":"integer","format":"int64","description":"User ID that created the quote.","example":55},"profile":{"type":"integer","format":"int64","description":"Personal or business profile ID.","example":101},"rateType":{"type":"string","description":"Whether the rate is fixed or floating.","enum":["FIXED","FLOATING"],"example":"FIXED"},"rateExpirationTime":{"type":"string","format":"date-time","description":"Date and time the locked rate expires.","example":"2019-04-08T13:18:57Z"},"guaranteedTargetAmountAllowed":{"type":"boolean","description":"Indicates whether guaranteed target amount is allowed.","example":true},"targetAmountAllowed":{"type":"boolean","description":"Indicates whether target amount is allowed.","example":true},"guaranteedTargetAmount":{"type":"boolean","description":"Indicates whether the target amount is guaranteed.","example":false},"providedAmountType":{"type":"string","description":"Indicates whether the quote was created as source or target.","enum":["SOURCE","TARGET"],"example":"SOURCE"},"pricingConfiguration":{"type":"object","description":"Allows partners to override pricing configurations on a transfer level.","properties":{"fee":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of fee to be configured. Options include only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"OVERRIDE"},"variable":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected variable percentage, in decimal format, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.011},"fixed":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected fixed fee, in source currency, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":15.42}}}}},"paymentOptions":{"type":"array","description":"List of the methods available to pay for the transfer.","items":{"type":"object","properties":{"disabled":{"type":"boolean","description":"Indicates whether this option is enabled or not for this quote.","example":false},"estimatedDelivery":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated delivery time for this combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" methods (assuming "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payIn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is performed now)."},"children":[]}]}]}],"example":"2019-04-08T12:30:00Z"},"formattedEstimatedDelivery":{"type":"string","description":"A customer-friendly string for the estimated delivery date, which you can pass through to your front-end.","example":"by Apr 8"},"estimatedDeliveryDelays":{"type":"array","description":"Array of objects for delivery delays you can display to your customers.","items":{"type":"object","properties":{"reason":{"type":"string","description":"Reason for the delivery delay.","example":"sample reason"}}}},"fee":{"type":"object","description":"Fee details for the quote.","properties":{"transferwise":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee to be paid "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on the current state of the quote."},"children":[]}]}]}],"example":3.04},"payIn":{"type":"number","description":"The fee for this payment option, based on the product type of the payment option.","example":0},"discount":{"type":"number","description":"Any discounts that have been applied to this quote.","example":2.27},"partner":{"type":"number","description":"Agreed-upon custom pricing, if applicable.","example":0},"total":{"type":"number","description":"The total fees to be paid. Use this value when displaying fees in your app.","example":0.77}}},"price":{"type":"object","description":"Price details for the quote.","properties":{"priceSetId":{"type":"integer","format":"int64","description":"ID of the price structure.","example":238},"total":{"type":"object","description":"The total fees to be paid. Use this value when displaying fees in your app.","properties":{"type":{"type":"string","description":"The type of the pricing element.","example":"TOTAL"},"label":{"type":"string","description":"Plain text describing the price structure.","example":"Total fees"},"value":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"properties":{"amount":{"type":"number","description":"Amount to be paid.","example":0.77},"currency":{"type":"string","description":"Currency of the amount to be paid.","example":"GBP"},"label":{"type":"string","description":"Plain text version of the price.","example":"0.77 GBP"}}},"explanation":{"type":"object","description":"Provides more details about the price."}}},"items":{"type":"array","description":"Details the different elements contained in the total price.","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the item."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the price item (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"FEE"},"label":{"type":"string","description":"Plain text describing the price element.","example":"fee"},"value":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value details for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price.items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"properties":{"amount":{"type":"number","description":"Amount associated with this price. Can be negative for discounts.","example":0},"currency":{"type":"string","description":"Currency of the price.","example":"GBP"},"label":{"type":"string","description":"Plain text description of the price and currency.","example":"0 GBP"}}},"explanation":{"type":"object","description":"Additional deails for a price breakdown item.","properties":{"plainText":{"type":"string","description":"Plain text details about the item."},"markdown":{"type":"string","description":"Formatted textual information about the item."}}}}}},"deferredFee":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deferred fee information from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" override."},"children":[]}]}]}],"properties":{"amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of fees deferred by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" override."},"children":[]}]}]}],"example":14.79},"currency":{"type":"string","description":"The currency of the deferred fee amount.","example":"BRL"}}},"calculatedOn":{"type":"object","properties":{"unroundedAmountToConvert":{"type":"object","description":"The amount, unrounded, that fees were calculated on and built up from.","properties":{"amount":{"type":"number","example":179.97342},"currency":{"type":"string","example":"BRL"}}}}}}},"sourceAmount":{"type":"number","description":"Source amount when using this payment option.","example":100},"targetAmount":{"type":"number","description":"Target amount when using this payment option.","example":129.24},"sourceCurrency":{"type":"string","description":"Source currency for this payment option.","example":"GBP"},"targetCurrency":{"type":"string","description":"Target currency for this payment option.","example":"USD"},"payIn":{"type":"string","description":"Type of pay in method for this payment option.","example":"BANK_TRANSFER"},"payOut":{"type":"string","description":"Type of pay out method for this payment option.","example":"BANK_TRANSFER"},"allowedProfileTypes":{"type":"array","description":"Array of the profile types allowed to use this payment option.","items":{"type":"string","enum":["PERSONAL","BUSINESS"]},"example":["PERSONAL","BUSINESS"]},"payInProduct":{"type":"string","description":"Pay-in product type.","example":"CHEAP"},"feePercentage":{"type":"number","description":"Fee percentage for this payment option.","example":0.0092},"disabledReason":{"type":"object","description":"Present only if a payment option is disabled.","properties":{"code":{"type":"string","description":"Denotes the reason a payment method is unavailable."},"message":{"type":"string","description":"User-friendly message to display when a method is unavailable."}}}}}},"status":{"type":"string","description":"Current status of the quote.","enum":["PENDING","ACCEPTED","FUNDED","EXPIRED"],"example":"PENDING"},"expirationTime":{"type":"string","format":"date-time","description":"The date and time the quote expires.","example":"2019-04-05T13:48:58Z"},"notices":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messages to display to the user. May be empty ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") if there are no messages."},"children":[]}]}]}],"items":{"type":"object","properties":{"text":{"type":"string","description":"The message to display.","example":"You can have a maximum of 3 open transfers with a guaranteed rate. After that, they'll be transferred using the live rate. Complete or cancel your other transfers to regain the use of guaranteed rate."},"link":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL that provides more details about the message. May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there's no URL."},"children":[]}]}]}],"example":null},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of message. If it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", don't allow the quote to be used to create the transfer."},"children":[]}]}]}],"enum":["WARNING","INFO","BLOCKED"],"example":"WARNING"}}}}}}},"components/schemas/recipient":{"id":"components/schemas/recipient","kind":"json-schema","title":"Recipient Account","data":{"type":"object","title":"Recipient Account","x-tags":["recipient"],"properties":{"id":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the recipient. Use the returned id as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify the refund recipient when creating transfers."},"children":[]}]}]}],"example":40000000},"creatorId":{"type":"integer","format":"int64","description":"Account entity that owns the recipient account.","example":41000000},"profileId":{"type":"integer","format":"int64","description":"Specific profile that owns the recipient account.","example":30000000},"name":{"type":"object","description":"Recipient name details.","properties":{"fullName":{"type":"string","description":"Recipient full name.","example":"John Doe"},"givenName":{"type":["string","null"],"description":"Recipient first name.","example":null},"familyName":{"type":["string","null"],"description":"Recipient surname.","example":null},"middleName":{"type":["string","null"],"description":"Recipient middle name.","example":null},"patronymicName":{"type":["string","null"],"description":"Recipient patronymic name (when applicable).","example":null},"cannotHavePatronymicName":{"type":["boolean","null"],"description":"Indicates if the recipient cannot have a patronymic name (when applicable).","example":null}}},"currency":{"type":"string","description":"3-character currency code.","example":"GBP"},"country":{"type":"string","description":"2-character country code.","example":"GB"},"type":{"type":"string","description":"Recipient account type.","example":"SortCode"},"legalEntityType":{"type":"string","description":"Entity type of recipient account.","example":"PERSON"},"active":{"type":"boolean","description":"Status of the recipient account.","example":true},"details":{"type":"object","description":"Contains the details of the recipient account specific to its currency and type. The fields required (in the request) or present (in the response) vary depending on currency route and recipient type (e.g., sort code, IBAN, SWIFT, email).","properties":{"reference":{"type":["string","null"],"description":"Recipient reference (applies for some routes).","example":null},"sortCode":{"type":"string","description":"Recipient bank sort code (GBP example).","example":"040075"},"accountNumber":{"type":"string","description":"Recipient bank account number (GBP example).","example":"37778842"},"hashedByLooseHashAlgorithm":{"type":"string","description":"Recipient account hash.","example":"ad245621b974efa3ef870895c3wer419a3f01af18a8a5790b47645dba6304194"}},"additionalProperties":true},"commonFieldMap":{"type":"object","description":"Map of key lookup fields for the account.","example":{"accountNumberField":"accountNumber","bankCodeField":"sortCode"}},"hash":{"type":"string","description":"Account hash for tracking changes to recipient details. This is useful for re-running any validation checks on the recipient, for example against fraud engines. The hash remains constant unless the recipient's name or information in the details object changes.","example":"666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479"},"accountSummary":{"type":"string","description":"Summary of account details for ease of lookup. Can be used to display recipient details in your UI.","example":"(04-00-75) 37778842"},"longAccountSummary":{"type":"string","description":"Longer account details summary. Can be used to display recipient details in your UI.","example":"GBP account ending in 8842"},"displayFields":{"type":"array","description":"Lookup fields (key/label/value) for rendering in your front-end. Allows you to build a UI containing all the dynamic fields for a recipient individually.","items":{"type":"object","properties":{"key":{"type":"string","description":"Account identifier key name."},"label":{"type":"string","description":"Account identifier display label."},"value":{"type":"string","description":"Account identifier value."}}},"example":[{"key":"details/sortCode","label":"UK sort code","value":"04-00-75"},{"key":"details/accountNumber","label":"Account number","value":"37778842"}]},"isInternal":{"type":"boolean","description":"Indicates whether recipient is internal.","example":false},"ownedByCustomer":{"type":"boolean","description":"Inidicates if recipient account belongs to profile owner.","example":false},"ultimateBeneficiary":{"type":["object","null"],"description":"The details for the ultimate beneficiary of this recipient.","required":["name"],"properties":{"accountNumber":{"type":["string","null"],"description":"Ultimate beneficiary account number.","example":"37778842"},"bankName":{"type":["string","null"],"description":"Ultimate beneficiary bank name.","example":"Wise Payments Limited"},"bankCode":{"type":["string","null"],"description":"Ultimate beneficiary bank code.","example":"026073150"},"name":{"type":"object","description":"Ultimate beneficiary name.","required":["fullName"],"properties":{"fullName":{"type":"string","description":"Ultimate beneficiary's full name.","example":"John Doe"}}},"address":{"type":["object","null"],"description":"Ultimate beneficiary address.","properties":{"country":{"type":"string","example":"US"},"firstLine":{"type":"string"},"postCode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}},"bankAddress":{"type":["object","null"],"description":"Ultimate beneficiary bank address.","properties":{"country":{"type":"string","example":"US"},"firstLine":{"type":"string"},"postCode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}}}},"confirmations":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains verification results for the recipient's details. Only populated for currencies with recipient verification enabled (CNY, KRW, INR, IDR, EUR)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/recipient-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient verification guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about how to handle this verification data by currency."},"children":[]}]}]}],"properties":{"acceptedOutcomes":{"type":"boolean","description":"Indicates whether we've received an explicit customer acceptance.","example":false},"acceptedAt":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp indicating date and time of outcome acceptance. Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until acceptance received."},"children":[]}]}]}],"example":null},"quoteId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the confirmation check was run as part of a quote compatibility check, then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the result. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present, the outcome acceptance needs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be specified as well."},"children":[]}]}]}],"example":null},"outcomes":{"type":"array","description":"Array of confirmation outcomes. Currently, it is safe to assume there is only one element in the outcomes array.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of confirmation. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_EXISTENCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_MATCHING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_RESOLUTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"NAME_MATCHING"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of when the confirmation check was performed.","example":"2024-11-11T23:58:11.105916743Z"},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual outcome of the confirmation check. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COULD_NOT_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PARTIAL_FAILURE"},"requiresCustomerAcceptance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether we require customer acceptance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for this field ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") depends on the currency and the nature of the confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must present your customer with the ability to accept or decline the confirmation result."},"children":[]}]}]}],"example":true},"fieldsChecked":{"type":"array","description":"Fields used to confirm the account.","items":{"type":"string"},"example":["name/fullName","details/accountNumber"]},"providedName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name the customer provided when creating the recipient account. Only populated for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_MATCHING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_RESOLUTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types for certain outcomes."},"children":[]}]}]}],"example":"John Doe"},"resolvedName":{"type":"string","description":"The name that we resolved during name matching or name resolution.","example":"Joe Doe"},"message":{"type":"string","description":"Customer-facing message about the outcome of the check.","example":"The name entered is slightly different to the name on the account."},"recommendedUpdates":{"type":"array","description":"Shows the correct values for some of the fields checked.","items":{"type":"object","properties":{"path":{"type":"string","description":"The field path to update.","example":"name/fullName"},"value":{"type":"string","description":"The recommended value for the field.","example":"Joe Doe"}}}}}}}}}}}},"components/schemas/recipient-create-request":{"id":"components/schemas/recipient-create-request","kind":"json-schema","title":"recipient-create-request","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a recipient (beneficiary) account request. The required fields inside the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object depend on currency and route. Use the account-requirements endpoints to discover the exact required fields."},"children":[]}]}]}],"properties":{"currency":{"type":"string","description":"3-character currency code.","example":"GBP"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient account type. These are currency/route-specific, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sort_code"},"profile":{"type":"integer","format":"int64","description":"Personal or business profile ID of the sender. We recommend passing the business profile ID if multiple users manage your business account so all users authorized on the business account can access the recipient.","example":30000000},"accountHolderName":{"type":"string","description":"Recipient full name.","example":"John Doe"},"ownedByCustomer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the recipient account is owned by the profile owner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While optional, we recommend setting to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for self-transfers (such as a user sending money to their own account in another country or currency)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distinguishing self-transfers from third-party transfers improves routing and processing efficiency."},"children":[]}]}]}],"example":true},"details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the details of the recipient account specific to its currency and type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common examples include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateOfBirth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc. Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve recipient account requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to determine what is required for a specific recipient."},"children":[]}]}]}],"properties":{"legalType":{"type":"string","description":"Recipient legal type.","enum":["PRIVATE","BUSINESS"],"example":"PRIVATE"},"sortCode":{"type":"string","description":"Sort code (GBP example).","example":"040075"},"accountNumber":{"type":"string","description":"Account number (GBP example).","example":"37778842"},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth in ISO 8601 date format. Only required for certain currency routes. Call the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieve recipient account requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to confirm."},"children":[]}]}]}],"example":"1961-01-01"}},"additionalProperties":true},"ultimateBeneficiary":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details about the ultimate beneficiary for this recipient, if present. If absent, the ultimate beneficiary "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the recipient."},"children":[]}]}]}],"required":["name"],"properties":{"accountNumber":{"type":["string","null"],"description":"Ultimate beneficiary account number.","example":"37778842"},"bankName":{"type":["string","null"],"description":"Ultimate beneficiary bank name.","example":"Wise Payments Limited"},"bankCode":{"type":["string","null"],"description":"Ultimate beneficiary bank code.","example":"026073150"},"name":{"type":"object","description":"Ultimate beneficiary name details.","required":["fullName"],"properties":{"fullName":{"type":"string","description":"Ultimate beneficiary full name.","example":"John Doe"}}},"address":{"type":["object","null"],"description":"Ultimate beneficiary address.","properties":{"country":{"type":"string","example":"US"},"firstLine":{"type":"string"},"postCode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}},"bankAddress":{"type":["object","null"],"description":"Ultimate beneficiary bank address.","properties":{"country":{"type":"string","example":"US"},"firstLine":{"type":"string"},"postCode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"}}}}}}}},"components/schemas/account-requirements-response":{"id":"components/schemas/account-requirements-response","kind":"json-schema","title":"account-requirements-response","data":{"type":"array","description":"Dynamic account-requirements response used to build recipient forms. The structure and the fields returned vary by currency, recipient type, route, and sometimes previously provided inputs. Treat this as a schema for a dynamically generated form definition rather than a fixed set of recipient fields.\n","items":{"type":"object","description":"A requirement group for a specific payout method / route.","properties":{"type":{"type":"string","description":"Requirement group identifier (route/payout-method specific).","example":"south_korean_paygate"},"title":{"type":"string","description":"Human-readable title for the requirement group.","example":"PayGate"},"usageInfo":{"type":"string","description":"Optional usage/help text.","example":null},"fields":{"type":"array","description":"List of UI field groups to collect required data.","items":{"type":"object","description":"Group of related fields shown together in UI.","properties":{"name":{"type":"string","description":"Display name of this group.","example":"E-mail"},"group":{"type":"array","description":"The actual fields within this group.","items":{"type":"object","description":"A single field descriptor.","properties":{"key":{"type":"string","description":"Key to include in JSON when submitting recipient details.","example":"email"},"name":{"type":"string","description":"Human-readable label.","example":"E-mail"},"type":{"type":"string","description":"UI field type.","example":"text"},"refreshRequirementsOnChange":{"type":"boolean","description":"If true, changing this field can alter requirements; call the POST account-requirements endpoint with updated data to refresh requirements.\n","example":false},"required":{"type":"boolean","description":"Indicates whether this field is mandatory.","example":true},"displayFormat":{"type":"string","description":"Optional display formatting hint.","example":null},"example":{"type":"string","description":"Example value for the field (may be empty string).","example":"example@example.ex"},"minLength":{"type":"integer","description":"Minimum allowed length, when applicable.","example":null},"maxLength":{"type":"integer","description":"Maximum allowed length, when applicable.","example":null},"validationRegexp":{"type":"string","description":"Regex pattern for validation, when applicable.","example":"^[^\\s]+@[^\\s]+\\.[^\\s]{2,}$"},"validationAsync":{"type":"string","deprecated":true,"description":"Deprecated. This validation will instead be performed when submitting the request.","example":null},"valuesAllowed":{"type":["array","null"],"description":"Allowed values for select/radio inputs; null for free-text/date inputs.","items":{"type":"object","properties":{"key":{"type":"string","description":"Machine-readable value.","example":"PRIVATE"},"name":{"type":"string","description":"Human-readable value label.","example":"Person"}}}}}}}}}}}},"example":[{"type":"south_korean_paygate","title":"PayGate","usageInfo":null,"fields":[{"name":"E-mail","group":[{"key":"email","name":"E-mail","type":"text","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"example@example.ex","minLength":null,"maxLength":null,"validationRegexp":"^[^\\s]+@[^\\s]+\\.[^\\s]{2,}$","validationAsync":null,"valuesAllowed":null}]},{"name":"Recipient type","group":[{"key":"legalType","name":"Recipient type","type":"select","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"","minLength":null,"maxLength":null,"validationRegexp":null,"validationAsync":null,"valuesAllowed":[{"key":"PRIVATE","name":"Person"}]}]},{"name":"Full Name","group":[{"key":"accountHolderName","name":"Full Name","type":"text","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"","minLength":2,"maxLength":140,"validationRegexp":"^[0-9A-Za-zÀ-ÖØ-öø-ÿ-_()'*,.%#^@{}~<>+$\"\\[\\]\\\\ ]+$","validationAsync":null,"valuesAllowed":null}]},{"name":"Recipient's Date of Birth","group":[{"key":"dateOfBirth","name":"Recipient's Date of Birth","type":"date","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"","minLength":null,"maxLength":null,"validationRegexp":"^\\d{4}\\-\\d{2}\\-\\d{2}$","validationAsync":null,"valuesAllowed":null}]},{"name":"Recipient Bank Name","group":[{"key":"bankCode","name":"Recipient Bank Name","type":"select","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"Choose recipient bank","minLength":null,"maxLength":null,"validationRegexp":null,"validationAsync":null,"valuesAllowed":[{"key":"","name":"Choose recipient bank"},{"key":"004","name":"Example Bank A"},{"key":"011","name":"Example Bank B"}]}]},{"name":"Account number (KRW accounts only)","group":[{"key":"accountNumber","name":"Account number (KRW accounts only)","type":"text","refreshRequirementsOnChange":false,"required":true,"displayFormat":null,"example":"1254693521232","minLength":10,"maxLength":16,"validationRegexp":null,"validationAsync":null,"valuesAllowed":null}]}]}]}},"components/schemas/confirmations":{"id":"components/schemas/confirmations","kind":"json-schema","title":"confirmations","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains verification results for the recipient's details. Only populated for currencies with recipient verification enabled (CNY, KRW, INR, IDR, EUR)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/recipient-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient verification guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details about how to handle this verification data by currency."},"children":[]}]}]}],"properties":{"acceptedOutcomes":{"type":"boolean","description":"Indicates whether we've received an explicit customer acceptance.","example":false},"acceptedAt":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp indicating date and time of outcome acceptance. Value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until acceptance received."},"children":[]}]}]}],"example":null},"quoteId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the confirmation check was run as part of a quote compatibility check, then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included in the result. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present, the outcome acceptance needs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be specified as well."},"children":[]}]}]}],"example":null},"outcomes":{"type":"array","description":"Array of confirmation outcomes. Currently, it is safe to assume there is only one element in the outcomes array.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of confirmation. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_EXISTENCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_MATCHING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_RESOLUTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"NAME_MATCHING"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of when the confirmation check was performed.","example":"2024-11-11T23:58:11.105916743Z"},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual outcome of the confirmation check. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COULD_NOT_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PARTIAL_FAILURE"},"requiresCustomerAcceptance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether we require customer acceptance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value for this field ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") depends on the currency and the nature of the confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must present your customer with the ability to accept or decline the confirmation result."},"children":[]}]}]}],"example":true},"fieldsChecked":{"type":"array","description":"Fields used to confirm the account.","items":{"type":"string"},"example":["name/fullName","details/accountNumber"]},"providedName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name the customer provided when creating the recipient account. Only populated for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_MATCHING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NAME_RESOLUTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types for certain outcomes."},"children":[]}]}]}],"example":"John Doe"},"resolvedName":{"type":"string","description":"The name that we resolved during name matching or name resolution.","example":"Joe Doe"},"message":{"type":"string","description":"Customer-facing message about the outcome of the check.","example":"The name entered is slightly different to the name on the account."},"recommendedUpdates":{"type":"array","description":"Shows the correct values for some of the fields checked.","items":{"type":"object","properties":{"path":{"type":"string","description":"The field path to update.","example":"name/fullName"},"value":{"type":"string","description":"The recommended value for the field.","example":"Joe Doe"}}}}}}}}}},"components/schemas/Address-2":{"id":"components/schemas/Address-2","kind":"json-schema","title":"Address-2","data":{"type":"object","properties":{"addressFirstLine":{"type":"string","minLength":1,"maxLength":70,"description":"Address line: street, house, apartment."},"city":{"type":"string","minLength":1,"maxLength":140,"description":"City name."},"postalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Postal code."},"stateCode":{"type":"string","minLength":1,"maxLength":16,"description":"State code."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country code (ISO 3166-1 alpha-2)."}}}},"components/schemas/bank-transaction-import-request":{"id":"components/schemas/bank-transaction-import-request","kind":"json-schema","title":"bank-transaction-import-request","data":{"$defs":{"Address":{"type":"object","properties":{"addressFirstLine":{"type":"string","minLength":1,"maxLength":70,"description":"Address line: street, house, apartment."},"city":{"type":"string","minLength":1,"maxLength":140,"description":"City name."},"postalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Postal code."},"stateCode":{"type":"string","minLength":1,"maxLength":16,"description":"State code."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country code (ISO 3166-1 alpha-2)."}}}},"type":"object","required":["currency","amount"],"properties":{"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"The currency of the bank account details that you want to make payment to."},"amount":{"type":"number","exclusiveMinimum":0,"description":"The payment amount."},"reference":{"type":"string","maxLength":255,"description":"Custom payment reference to identify the payment.","example":"Test transfer"},"senderName":{"type":"string","maxLength":255,"description":"Sender full name.","example":"Jane Doe"},"senderBankCode":{"type":"string","maxLength":255,"description":"Sender bank code.","example":"101019628"},"senderAccountNumber":{"type":"string","maxLength":255,"description":"Sender's bank account number.","example":"1234567890"},"beneficiaryName":{"type":"string","maxLength":255,"description":"Beneficiary name - defaults to account holder name.","example":"John Doe"},"senderAddress":{"maxLength":255,"description":"Sender address.","$ref":"#/components/schemas/Address-2"},"beneficiaryAddress":{"description":"Beneficiary address.","$ref":"#/components/schemas/Address-2"}}}},"components/schemas/Address-3":{"id":"components/schemas/Address-3","kind":"json-schema","title":"Address-3","data":{"type":"object","properties":{"addressLine":{"type":"string","minLength":1,"maxLength":70,"description":"Address line: street, house, apartment."},"city":{"type":"string","minLength":1,"maxLength":140,"description":"City name."},"postalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Postal code."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country code (ISO 3166-1 alpha-2)."}}}},"components/schemas/BankDetails":{"id":"components/schemas/BankDetails","kind":"json-schema","title":"Bank details","data":{"title":"Bank details","type":"object","anyOf":[{"title":"BIC","required":["bic"]},{"title":"LEI","required":["lei"]},{"title":"Clearing system","required":["clearingSystemCode","clearingSystemMemberId"]},{"title":"Name and address","required":["name","address"]}],"properties":{"bic":{"$ref":"#/components/schemas/Bic","description":"BIC of the sender's bank.","example":"DEUTDEDBFRA"},"name":{"type":"string","minLength":1,"description":"Name of the sender's bank.","example":"Example Bank"},"lei":{"type":"string","pattern":"^[A-Z0-9]{18,18}[0-9]{2,2}$","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI) of the sender bank.","example":"5493001KJTIIGC8Y1R12"},"clearingSystemCode":{"type":"string","maxLength":5,"minLength":1,"pattern":"^[A-Z0-9]+$","description":"Code identifying the clearing system in which the sender bank is registered.","example":"DEBLZ"},"clearingSystemMemberId":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[A-Z0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the sender bank within the clearing system specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingSystemCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"50070010"},"address":{"description":"Address of the sender's bank.","allOf":[{"$ref":"#/components/schemas/Address-3"},{"type":"object","properties":{"addressLine":{"example":"1 Bank Street"},"city":{"example":"Frankfurt"},"postalCode":{"example":"60311"},"country":{"example":"DE"}}}]}}}},"components/schemas/swift-in-request":{"id":"components/schemas/swift-in-request","kind":"json-schema","title":"swift-in-request","data":{"$defs":{"Address":{"type":"object","properties":{"addressLine":{"type":"string","minLength":1,"maxLength":70,"description":"Address line: street, house, apartment."},"city":{"type":"string","minLength":1,"maxLength":140,"description":"City name."},"postalCode":{"type":"string","minLength":1,"maxLength":16,"description":"Postal code."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country code (ISO 3166-1 alpha-2)."}}},"BankDetails":{"title":"Bank details","type":"object","anyOf":[{"title":"BIC","required":["bic"]},{"title":"LEI","required":["lei"]},{"title":"Clearing system","required":["clearingSystemCode","clearingSystemMemberId"]},{"title":"Name and address","required":["name","address"]}],"properties":{"bic":{"$ref":"#/components/schemas/Bic","description":"BIC of the sender's bank.","example":"DEUTDEDBFRA"},"name":{"type":"string","minLength":1,"description":"Name of the sender's bank.","example":"Example Bank"},"lei":{"type":"string","pattern":"^[A-Z0-9]{18,18}[0-9]{2,2}$","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI) of the sender bank.","example":"5493001KJTIIGC8Y1R12"},"clearingSystemCode":{"type":"string","maxLength":5,"minLength":1,"pattern":"^[A-Z0-9]+$","description":"Code identifying the clearing system in which the sender bank is registered.","example":"DEBLZ"},"clearingSystemMemberId":{"type":"string","maxLength":35,"minLength":1,"pattern":"^[A-Z0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the sender bank within the clearing system specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearingSystemCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"50070010"},"address":{"description":"Address of the sender's bank.","allOf":[{"$ref":"#/components/schemas/Address-3"},{"type":"object","properties":{"addressLine":{"example":"1 Bank Street"},"city":{"example":"Frankfurt"},"postalCode":{"example":"60311"},"country":{"example":"DE"}}}]}}}},"type":"object","required":["currencyCode","amount"],"dependentRequired":{"instructedCurrencyCode":["instructedAmount"]},"not":{"required":["senderBic","senderBank"]},"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode","description":"Currency received by Wise. 3-letter ISO currency code.","example":"EUR"},"amount":{"type":"number","description":"Amount received by Wise.","exclusiveMinimum":0,"example":100},"instructedCurrencyCode":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency sent by the sender. 3-letter ISO currency code. If not provided, it is assumed to be the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"EUR"},"instructedAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount sent by the sender."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, it is assumed to be the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same currency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any outstanding fees in other currencies are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instructedCurrencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}],"exclusiveMinimum":0,"example":101},"beneficiaryName":{"type":"string","minLength":1,"maxLength":140,"description":"Name of the ultimate beneficiary.","example":"John Doe"},"beneficiaryAccount":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number of the ultimate beneficiary. It can be either a local account number or an IBAN."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the provided IBAN resolves to a BIC that does not match any connected test BICs, simulation is not allowed and an error is returned."},"children":[]}]}]}]}],"example":"8599680548"},"beneficiaryAddress":{"description":"Address of the ultimate beneficiary.","allOf":[{"$ref":"#/components/schemas/Address-3"},{"type":"object","properties":{"addressLine":{"example":"1234 Elm St, IL"},"city":{"example":"Springfield"},"postalCode":{"example":"62704"},"country":{"example":"US"}}}]},"senderName":{"type":"string","minLength":1,"maxLength":140,"description":"Name of the sender.","example":"Jane Doe"},"senderBic":{"$ref":"#/components/schemas/Bic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIC of the sender's bank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderBank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"senderBank":{"$ref":"#/components/schemas/BankDetails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the sender's bank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderBic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"senderAccount":{"type":"string","description":"Account number of the sender. It can be either an IBAN or local account number.","example":"DE89370400440532013000"},"senderAddress":{"description":"Address of the sender.","allOf":[{"$ref":"#/components/schemas/Address-3"},{"type":"object","properties":{"addressLine":{"example":"5678 Oak St"},"city":{"example":"Springfield"},"postalCode":{"example":"62704"},"country":{"example":"US"}}}]},"paymentReference":{"type":"string","maxLength":35,"description":"Custom payment reference.","example":"Test123"},"charges":{"type":"array","description":"List of fees declared by correspondents (e.g., handling fee).","items":{"type":"object","required":["amount","currency","agent"],"properties":{"amount":{"type":"number","description":"Fee amount.","exclusiveMinimum":0,"example":1},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Fee currency. 3-letter ISO currency code.","example":"EUR"},"agent":{"$ref":"#/components/schemas/Bic","description":"BIC of the agent incurring the fee.","example":"DEUTDEDBFRA"}}}},"previousInstructingAgents":{"type":"array","maxItems":3,"description":"List of previous instructing agents. Maximum 3 items.","items":{"$ref":"#/components/schemas/Bic","description":"BIC of a previous instructing agent.","example":"COBADEFFXXX"}}}}},"components/schemas/rule":{"id":"components/schemas/rule","kind":"json-schema","title":"Authorisation Rule","data":{"title":"Authorisation Rule","x-tags":["spend-controls"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The unique ID for the authorisation rule."},"type":{"type":"string","enum":["MCC","CURRENCY"],"description":"The type of authorisation rule."},"operation":{"type":"string","enum":["ALLOW","BLOCK"],"description":"Determines whether the transactions should be allowed or blocked."},"description":{"type":"string","description":"The description of the authorisation rule."},"values":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of values based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of rule configured."},"children":[]}]}]}]}},"example":{"id":123,"description":"my authorisation rule","type":"MCC","operation":"BLOCK","values":["1234","5678"]}}},"components/schemas/profile-limits":{"id":"components/schemas/profile-limits","kind":"json-schema","title":"Profile Limits","data":{"title":"Profile Limits","x-tags":["spend-limits"],"type":"object","properties":{"type":{"type":"string","enum":["PURCHASE","ATM_WITHDRAWAL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a combined limit that applies to contactless, magnetic, online purchase, chip and PIN/mobile wallet transactions."},"children":[]}]}]}]},"aggregateWindow":{"type":"object","properties":{"daily":{"type":"object","properties":{"value":{"type":"object","description":"Daily limit. The value should be between 0 and the max allowed.","properties":{"amount":{"type":"number","example":20000},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount to date.","properties":{"amount":{"type":"number","example":0},"currency":{"type":"string","example":"GBP"}}},"max":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max allowed limit for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2899986/what-are-my-spending-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"daily"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"type":"number","example":30000},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":"string","format":"date-time","description":"The time when the limit gets reset. ISO-8601 timestamp with timezone.","example":"2023-07-31T22:59:59.999999999Z"}}},"monthly":{"type":"object","properties":{"value":{"type":"object","description":"Monthly limit. The value should be between 0 and the max allowed.","properties":{"amount":{"type":"number","example":20000},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount to date.","properties":{"amount":{"type":"number","example":0},"currency":{"type":"string","example":"GBP"}}},"max":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max allowed limit for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2899986/what-are-my-spending-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monthly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"type":"number","example":30000},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":"string","format":"date-time","description":"The time when the limit gets reset. ISO-8601 timestamp with timezone.","example":"2023-07-31T22:59:59.999999999Z"}}}}}}}},"components/schemas/card-limits":{"id":"components/schemas/card-limits","kind":"json-schema","title":"Card Limits","data":{"title":"Card Limits","x-tags":["spend-limits"],"type":"object","properties":{"transaction":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Transaction limit.","properties":{"amount":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount. Always 0 for transaction limit.","properties":{"amount":{"type":"number","example":0},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":["string","null"],"format":"date-time","description":"The time when the limit gets reset. Null for transaction limit.","example":null}}},"daily":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Daily limit.","properties":{"amount":{"type":"number","example":2000},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount during the daily window.","properties":{"amount":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":["string","null"],"format":"date-time","description":"The time when the limit gets reset. ISO-8601 timestamp with timezone.","example":"2023-09-29T22:59:59.999999999Z"}}},"monthly":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Monthly limit.","properties":{"amount":{"type":"number","example":3000},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount during the monthly window.","properties":{"amount":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":["string","null"],"format":"date-time","description":"The time when the limit gets reset. ISO-8601 timestamp with timezone.","example":"2023-09-30T22:59:59.999999999Z"}}},"lifetime":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Lifetime limit.","properties":{"amount":{"type":"number","example":5000},"currency":{"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount over the lifetime of the card.","properties":{"amount":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"resetAt":{"type":["string","null"],"format":"date-time","description":"The time when the limit gets reset. Null for lifetime limit.","example":null}}}}}},"components/schemas/card-holder-limits":{"id":"components/schemas/card-holder-limits","kind":"json-schema","title":"Card Holder Limits","data":{"title":"Card Holder Limits","x-tags":["spend-limits"],"type":"object","properties":{"spendLimits":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spend limits configured for this cardholder. These limits apply to the cardholder's combined spending across all cards belonging to them, rather than to an individual card or the entire business profile. Empty when no cardholder limits are configured. Currently contains at most one entry, representing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" limit type."},"children":[]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","description":"The category of spending the limit applies to.","enum":["PURCHASE"],"example":"PURCHASE"},"aggregateWindow":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limits per aggregation window. A window is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no limit is configured for it."},"children":[]}]}]}],"properties":{"daily":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Daily limit.","properties":{"amount":{"type":"number","example":1000},"currency":{"minLength":3,"maxLength":3,"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount during the daily window, across all cards belonging to the cardholder.","properties":{"amount":{"type":"number","example":100},"currency":{"minLength":3,"maxLength":3,"type":"string","example":"GBP"}}},"resetAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the usage resets. This is the end of the current day in the business profile's timezone, expressed as a UTC timestamp. A profile with no timezone configured defaults to UTC. For example, a Singapore profile's daily window ends at 23:59:59.999+08:00, serialised as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-07-31T15:59:59.999Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2023-07-31T15:59:59.999Z"}}},"monthly":{"type":["object","null"],"properties":{"value":{"type":"object","description":"Monthly limit.","properties":{"amount":{"type":"number","example":3000},"currency":{"minLength":3,"maxLength":3,"type":"string","example":"GBP"}}},"usage":{"type":"object","description":"The total authorised amount during the monthly window, across all cards belonging to the cardholder.","properties":{"amount":{"type":"number","example":100},"currency":{"type":"string","minLength":3,"maxLength":3,"example":"GBP"}}},"resetAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the usage resets. This is the end of the current month in the business profile's timezone, expressed as a UTC timestamp. A profile with no timezone configured defaults to UTC. For example, a Singapore profile's daily window ends at 23:59:59.999+08:00, serialised as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-07-31T15:59:59.999Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2023-07-31T15:59:59.999Z"}}}}}}}}}}},"components/schemas/access-error":{"id":"components/schemas/access-error","kind":"json-schema","title":"Access Error","data":{"title":"Access Error","type":"object","required":["type","status","code","detail"],"properties":{"type":{"type":"string","description":"The type of error.","example":"/errors/types/access"},"status":{"type":"integer","description":"The HTTP status code.","example":403},"code":{"type":"string","description":"The error code.","example":"unauthorized"},"detail":{"type":"string","description":"A description of the error.","example":"Operation is unauthorized"}}}},"components/schemas/validation-error-2":{"id":"components/schemas/validation-error-2","kind":"json-schema","title":"Validation Error","data":{"title":"Validation Error","type":"object","required":["type","title","status","instance","errors"],"properties":{"type":{"type":"string","description":"A URI identifying the error type.","example":"/errors/types/validation"},"title":{"type":"string","description":"A short summary of the error.","example":"Validation Error"},"status":{"type":"integer","description":"The HTTP status code.","example":422},"instance":{"type":"string","description":"The API path associated with the error.","example":"/public/v4/spend/profiles/14974487/card-holder-profiles/14974487/spend-limits"},"errors":{"type":"array","description":"The individual validation errors.","items":{"type":"object","required":["code","ref","detail"],"properties":{"code":{"type":"string","description":"The validation error code.","example":"invalid_value"},"ref":{"type":"string","description":"The parameter or field that caused the error.","example":"businessProfileId"},"detail":{"type":"string","description":"A description of the validation error.","example":"businessProfileId must reference a business profile"}}}}}}},"components/schemas/server-error":{"id":"components/schemas/server-error","kind":"json-schema","title":"Server Error","data":{"title":"Server Error","type":"object","required":["type","status","detail"],"properties":{"type":{"type":"string","description":"The type of error.","example":"/errors/types/server"},"status":{"type":"integer","description":"The HTTP status code.","example":500},"detail":{"type":"string","description":"A description of the error.","example":"An unexpected error occurred"}}}},"components/schemas/one-time-token":{"id":"components/schemas/one-time-token","kind":"json-schema","title":"One-Time Token","data":{"title":"One-Time Token","x-tags":["sca-ott"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A one-time token is generated when accessing an endpoint secured by SCA. This token includes a list of all available challenges to complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-ott/ottstatusget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTT status endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view challenges and their statuses, or use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/sca-sessions/scasessioncreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create SCA session"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manually trigger SCA and return a one-time token."},"children":[]}]}]}],"properties":{"oneTimeToken":{"type":"string","format":"uuid","description":"A one-time token unique identifier.","example":"5932d5b5-ec13-452f-8688-308feade7834"},"challenges":{"type":"array","description":"An array of challenges.","items":{"type":"object","properties":{"primaryChallenge":{"type":"object","properties":{"type":{"type":"string","description":"A type of challenge.","example":"PIN"}}},"passed":{"type":"boolean","description":"The status of a challenge.","example":false}}}},"validity":{"type":"integer","description":"The One-Time Token expiration in seconds.","example":3600}}}},"components/schemas/transfer":{"id":"components/schemas/transfer","kind":"json-schema","title":"Standard Transfer","data":{"title":"Standard Transfer","x-tags":["transfer"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Transfer ID","example":16521632},"user":{"type":"integer","format":"int64","description":"Your user ID","example":4342275},"targetAccount":{"type":"integer","format":"int64","description":"Recipient account ID","example":8692237},"sourceAccount":{"type":["integer","null"],"format":"int64","description":"Refund recipient account ID","example":null},"quote":{"type":["integer","null"],"format":"int64","description":"V1 quote ID","example":null},"quoteUuid":{"type":"string","format":"uuid","description":"V2 quote ID","example":"8fa9be20-ba43-4b15-abbb-9424e1481050"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer current status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible statuses."},"children":[]}]}]}],"example":"incoming_payment_waiting"},"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"deprecated":true,"example":"reference text"},"rate":{"type":"number","description":"Exchange rate value","example":0.89},"created":{"type":"string","format":"date-time","description":"Timestamp when transfer was created","example":"2017-11-24 10:47:49"},"business":{"type":["integer","null"],"format":"int64","description":"Your business profile ID","example":null},"transferRequest":{"type":["integer","null"],"description":"Deprecated","deprecated":true,"example":null},"details":{"type":"object","properties":{"reference":{"type":"string","description":"Payment reference text","example":"Testing"}}},"hasActiveIssues":{"type":"boolean","description":"Are there any pending issues which stop executing the transfer?","example":false},"sourceCurrency":{"type":"string","description":"Source currency code","example":"EUR"},"sourceValue":{"type":"number","description":"Transfer amount in source currency","example":0},"targetCurrency":{"type":"string","description":"Target currency code","example":"GBP"},"targetValue":{"type":"number","description":"Transfer amount in target currency","example":150},"customerTransactionId":{"type":"string","format":"uuid","description":"Unique identifier randomly generated per transfer request by the calling client","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"payinSessionId":{"type":"string","format":"uuid","description":"ID of the Payin Session generated for the transfer, which can be used for certain payin methods when funding the transfer","example":"23330542-8e9e-419f-95eb-312b880f92ad"}}}},"components/schemas/originator-transfer":{"id":"components/schemas/originator-transfer","kind":"json-schema","title":"Originator Transfer","data":{"title":"Originator Transfer","x-tags":["transfer"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Transfer ID","example":16521632},"user":{"type":"integer","format":"int64","description":"Your user ID","example":4342275},"targetAccount":{"type":"integer","format":"int64","description":"Recipient account ID","example":8692237},"sourceAccount":{"type":["integer","null"],"format":"int64","description":"Refund recipient account ID","example":null},"quote":{"type":"string","description":"Quote ID","example":"8fa9be20-ba43-4b15-abbb-9424e1481050"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer's current status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/transfer-statuses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible statuses."},"children":[]}]}]}],"example":"cancelled"},"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true,"example":"reference text"},"rate":{"type":"number","description":"Exchange rate value","example":0.89},"created":{"type":"string","format":"date-time","description":"Timestamp when transfer was created.","example":"2025-10-29T12:28:16.000Z"},"business":{"type":["integer","null"],"format":"int64","description":"Your business profile ID","example":null},"transferRequest":{"type":["integer","null"],"description":"Deprecated","deprecated":true,"example":null},"details":{"type":"object","properties":{"reference":{"type":"string","description":"Payment reference text","example":"Testing"}}},"originator":{"type":"object","description":"Data block to capture payment originator details.","properties":{"legalEntityType":{"type":"string","enum":["PRIVATE","BUSINESS"],"description":"Payment originator legal type.","example":"PRIVATE"},"reference":{"type":"string","description":"Unique customer ID in your system. This allows Wise to uniquely identify each originator. Must be the same ID across all transfers sent by the originator.","example":"CST-2991992"},"name":{"type":"object","properties":{"givenName":{"type":"string","description":"Payment originator first name","example":"John"},"middleNames":{"type":"array","items":{"type":"string"},"description":"Payment originator middle name(s)","example":["Ryan"]},"familyName":{"type":"string","description":"Payment originator family name","example":"Godspeed"},"patronymicName":{"type":["string","null"],"description":"Payment originator patronymic name","example":null},"fullName":{"type":"string","description":"Payment originator full legal name","example":"John Godspeed"}}},"dateOfBirth":{"type":"string","format":"date","description":"Payment originator date of birth","example":"1977-07-01"},"businessRegistrationCode":{"type":["string","null"],"description":"Payment originator business registry or incorporation number","example":null},"address":{"type":"object","properties":{"firstLine":{"type":"string","description":"Payment originator address first line","example":"Salu tee 14"},"city":{"type":"string","description":"Payment originator address city","example":"Tallinn"},"stateCode":{"type":["string","null"],"description":"Payment originator address state code","example":null},"countryCode":{"type":"string","description":"Payment originator address country code (ISO 3166-1 alpha-2)","example":"EE"},"postCode":{"type":"string","description":"Payment originator address zip code","example":"12112"}}},"accountDetails":{"type":"string","description":"Originator account number","example":"23456789"}}},"hasActiveIssues":{"type":"boolean","description":"Indicates any pending issues that could stop the transfer from executing.","example":false},"sourceCurrency":{"type":"string","description":"Source currency code","example":"EUR"},"sourceValue":{"type":"number","description":"Transfer amount in source currency","example":0},"targetCurrency":{"type":"string","description":"Target currency code","example":"GBP"},"targetValue":{"type":"number","description":"Transfer amount in target currency","example":150},"originalTransferId":{"type":"string","description":"Unique identifier randomly generated per transfer request by the calling client.","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"payinSessionId":{"type":"string","format":"uuid","description":"ID of the Payin Session generated for the transfer, which can be used for certain payin methods when funding the transfer.","example":"23330542-8e9e-419f-95eb-312b880f92ad"}}}},"components/schemas/transfer-requirement":{"id":"components/schemas/transfer-requirement","kind":"json-schema","title":"Transfer Requirement","data":{"title":"Transfer Requirement","type":"object","properties":{"type":{"type":"string","description":"Resource type","example":"transfer"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Field description"},"group":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Name of the field to include in the JSON"},"name":{"type":"string","description":"Field description"},"type":{"type":"string","description":"Display type of field (e.g. text, select)"},"refreshRequirementsOnChange":{"type":"boolean","description":"Whether to call POST transfer-requirements again once the field value is set to discover required lower level fields"},"required":{"type":"boolean","description":"Indicates if the field is mandatory"},"displayFormat":{"type":["string","null"],"description":"Display format pattern"},"example":{"type":["string","null"],"description":"Example value"},"minLength":{"type":["integer","null"],"format":"int32","description":"Minimum valid length of field value"},"maxLength":{"type":["integer","null"],"format":"int32","description":"Maximum valid length of field value"},"validationRegexp":{"type":["string","null"],"description":"Regexp validation pattern"},"validationAsync":{"type":["string","null"],"description":"Deprecated. This validation will instead be performed when submitting the request","deprecated":true},"valuesAllowed":{"type":["array","null"],"description":"List of allowed values","items":{"type":"object","properties":{"key":{"type":"string","description":"Value key"},"name":{"type":"string","description":"Value name"}}}}}}}}}}}}},"components/schemas/Details":{"id":"components/schemas/Details","kind":"json-schema","title":"Details","data":{"type":"object","properties":{"reference":{"type":"string","maxLength":250,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient will see this reference text in their bank statement. Maximum allowed characters depends on the currency route."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2932870/tips-for-paying-invoices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Payments Tips"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a full list"},"children":[]}]}]}],"example":"T12789649"}}}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","description":"Data block to capture the originator name details","properties":{"givenName":{"type":"string","description":"Payment originator first name","example":"John"},"middleNames":{"type":"array","items":{"type":"string"},"maxItems":10,"description":"Payment originator middle name(s)"},"familyName":{"type":"string","description":"Payment originator family name","example":"Godspeed"},"patronymicName":{"type":"string","description":"Payment originator patronymic name","example":"Fitz"},"fullName":{"type":"string","description":"Payment originator full legal name","example":"John Godspeed"}}}},"components/schemas/Address-4":{"id":"components/schemas/Address-4","kind":"json-schema","title":"Address-4","data":{"type":"object","properties":{"firstLine":{"type":"string","maxLength":250,"minLength":1,"pattern":"\\S","description":"Payment originator address first line","example":"Salu tee 14"},"city":{"type":"string","maxLength":250,"description":"Payment originator address city","example":"Tallinn"},"stateCode":{"type":"string","description":"Payment originator address state code. Required if address country code in (US, CA, BR, AU)","example":"NY"},"countryCode":{"type":"string","maxLength":2,"minLength":1,"pattern":"\\S","description":"Payment originator address country code ISO 3166-1 alpha-2","example":"EE"},"postCode":{"type":"string","maxLength":250,"description":"Originator address zip code","example":"12112"}},"required":["countryCode","firstLine"]}},"components/schemas/PrivateOriginator":{"id":"components/schemas/PrivateOriginator","kind":"json-schema","title":"PrivateOriginator","data":{"type":"object","properties":{"reference":{"type":"string","minLength":1,"pattern":"\\S","description":"Unique customer ID in your system. This allows us to uniquely identify each originator","example":"CST-2991992"},"name":{"$ref":"#/components/schemas/Name","description":"Data block to capture the originator name details"},"dateOfBirth":{"type":"string","description":"Payment originator date of birth","format":"date","example":"1977-07-01","x-temporal-constraint":"past"},"nationality":{"type":"string","description":"Payment originator nationality. Required for certain routes (e.g. to UGX)","example":"EE"},"accountDetails":{"type":"string","description":"Payment originator account number","example":"23456789"},"address":{"$ref":"#/components/schemas/Address-4","description":"Payment originator address"}},"required":["address","dateOfBirth","name","reference"]}},"components/schemas/OriginatorMixin":{"id":"components/schemas/OriginatorMixin","kind":"json-schema","title":"OriginatorMixin","data":{"type":"object","properties":{"legalEntityType":{"type":"string"}},"required":["legalEntityType"]}},"components/schemas/OriginatorPRIVATE":{"id":"components/schemas/OriginatorPRIVATE","kind":"json-schema","title":"OriginatorPRIVATE","data":{"allOf":[{"$ref":"#/components/schemas/PrivateOriginator"},{"$ref":"#/components/schemas/OriginatorMixin"}]}},"components/schemas/BusinessOriginator":{"id":"components/schemas/BusinessOriginator","kind":"json-schema","title":"BusinessOriginator","data":{"type":"object","description":"Data block to capture payment originator details for a business entity","properties":{"reference":{"type":"string","minLength":1,"pattern":"\\S","description":"Unique customer ID in your system. This allows us to uniquely identify each originator","example":"CST-2991992"},"name":{"$ref":"#/components/schemas/Name","description":"Data block to capture the originator name details"},"businessRegistrationCode":{"type":"string","maxLength":150,"description":"Payment originator business registry number / incorporation number","example":"83920-546"},"businessRegistrationDate":{"type":"string","description":"Payment originator business registration date. Required for certain routes (e.g. to UGX)","format":"date","example":"2020-01-15","x-temporal-constraint":"pastOrPresent"},"accountDetails":{"type":"string","description":"Payment originator account number","example":"23456789"},"address":{"$ref":"#/components/schemas/Address-4","description":"Payment originator address"}},"required":["address","name","reference"]}},"components/schemas/OriginatorBUSINESS":{"id":"components/schemas/OriginatorBUSINESS","kind":"json-schema","title":"OriginatorBUSINESS","data":{"allOf":[{"$ref":"#/components/schemas/BusinessOriginator"},{"$ref":"#/components/schemas/OriginatorMixin"}]}},"components/schemas/Originator":{"id":"components/schemas/Originator","kind":"json-schema","title":"Originator","data":{"oneOf":[{"$ref":"#/components/schemas/OriginatorPRIVATE"},{"$ref":"#/components/schemas/OriginatorBUSINESS"}],"discriminator":{"propertyName":"legalEntityType","mapping":{"PRIVATE":"#/components/schemas/OriginatorPRIVATE","BUSINESS":"#/components/schemas/OriginatorBUSINESS"}}}},"components/schemas/CreateThirdPartyTransferRequestContent":{"id":"components/schemas/CreateThirdPartyTransferRequestContent","kind":"json-schema","title":"CreateThirdPartyTransferRequestContent","data":{"type":"object","properties":{"originalTransferId":{"type":"string","maxLength":250,"minLength":1,"pattern":"\\S","description":"Unique transfer ID in your system. We use this field also to perform idempotency check to avoid duplicate transfers in case of network failures or timeouts.\n You can only submit one transfer with same originalTransferId.","example":"4711"},"targetAccount":{"type":"integer","description":"Recipient account ID.","format":"int64","example":7839323},"sourceAccount":{"type":"integer","description":"Refund recipient account ID.","format":"int64","example":1527389},"quote":{"type":"string","minLength":1,"pattern":"\\S","description":"Quote ID. You can only create one transfer per one quote.\n You cannot use same quote ID to create multiple transfers.","example":"3522e360-356a-4e37-9f99-94a21898d8fa"},"details":{"$ref":"#/components/schemas/Details","description":"Data block to capture payment details."},"originator":{"$ref":"#/components/schemas/Originator","description":"Data block to capture payment originator details."}},"required":["details","originalTransferId","originator","quote","targetAccount"]}},"components/schemas/DetailsResponse":{"id":"components/schemas/DetailsResponse","kind":"json-schema","title":"DetailsResponse","data":{"type":"object","properties":{"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient will see this reference text in their bank statement. Maximum allowed characters depends on the currency route."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2932870/tips-for-paying-invoices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Payments Tips"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a full list"},"children":[]}]}]}],"example":"T12789649"}}}},"components/schemas/LegalEntityTypeResponse":{"id":"components/schemas/LegalEntityTypeResponse","kind":"json-schema","title":"LegalEntityTypeResponse","data":{"type":"string","enum":["PRIVATE","BUSINESS"]}},"components/schemas/NameResponse":{"id":"components/schemas/NameResponse","kind":"json-schema","title":"NameResponse","data":{"type":"object","description":"Data block to capture the originator name details","properties":{"givenName":{"type":"string","description":"Payment originator first name","example":"John"},"middleNames":{"type":"array","items":{"type":"string"},"description":"Payment originator middle name(s)","example":["Fitz","John"]},"familyName":{"type":"string","description":"Payment originator family name","example":"Godspeed"},"patronymicName":{"type":"string","description":"Payment originator patronymic name","example":"Fitz"},"fullName":{"type":"string","description":"Payment originator full legal name","example":"John Godspeed"}}}},"components/schemas/AddressResponse":{"id":"components/schemas/AddressResponse","kind":"json-schema","title":"AddressResponse","data":{"type":"object","properties":{"firstLine":{"type":"string","description":"Payment originator address first line","example":"Salu tee 14"},"city":{"type":"string","description":"Payment originator address city","example":"Tallinn"},"stateCode":{"type":"string","description":"Payment originator address state code. Required if address country code in (US, CA, BR, AU)","example":"NY"},"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"Payment originator address country code ISO 3166-1 alpha-2","example":"EE"},"postCode":{"type":"string","description":"Originator address zip code","example":"12112"}}}},"components/schemas/OriginatorResponse":{"id":"components/schemas/OriginatorResponse","kind":"json-schema","title":"OriginatorResponse","data":{"type":"object","properties":{"legalEntityType":{"$ref":"#/components/schemas/LegalEntityTypeResponse","description":"Payment originator legal type"},"reference":{"type":"string","description":"Unique customer ID in your system. This allows us to uniquely identify each originator","example":"CST-2991992"},"name":{"$ref":"#/components/schemas/NameResponse","description":"Data block to capture the originator name details"},"dateOfBirth":{"type":"string","description":"Payment originator date of birth","format":"date","example":"1977-07-01"},"nationality":{"type":"string","description":"Payment originator nationality. Required for certain routes (e.g. to UGX)","example":"EE"},"accountDetails":{"type":"string","description":"Payment originator account number","example":"23456789"},"address":{"$ref":"#/components/schemas/AddressResponse","description":"Payment originator address"},"businessRegistrationCode":{"type":"string","description":"Payment originator business registry number / incorporation number","example":"83920-546"},"businessRegistrationDate":{"type":"string","description":"Payment originator business registration date. Required for certain routes (e.g. to UGX)","format":"date","example":"2020-01-15"}}}},"components/schemas/CreateThirdPartyTransferResponseContent":{"id":"components/schemas/CreateThirdPartyTransferResponseContent","kind":"json-schema","title":"CreateThirdPartyTransferResponseContent","data":{"type":"object","description":"Returns the originator transfer object.","properties":{"id":{"type":"integer","description":"Transfer ID","format":"int64","example":16521632},"user":{"type":"integer","description":"Your user ID","format":"int64","example":4342275},"targetAccount":{"type":"integer","description":"Recipient account ID","format":"int64","example":8692237},"sourceAccount":{"type":"integer","description":"Refund recipient account ID","format":"int64","example":1527389},"quote":{"type":"string","description":"Quote ID","example":"8fa9be20-ba43-4b15-abbb-9424e1481050"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer current status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.wise.com/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible statuses."},"children":[]}]}]}],"example":"cancelled"},"rate":{"type":"number","description":"Exchange rate value","format":"decimal","example":0.89},"details":{"$ref":"#/components/schemas/DetailsResponse","description":"Payment Details"},"originator":{"$ref":"#/components/schemas/OriginatorResponse","description":"Data block to capture payment originator details"},"hasActiveIssues":{"type":"boolean","description":"Are there any pending issues which stop executing the transfer?","example":false},"sourceCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Source currency code","example":"EUR"},"sourceValue":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Transfer amount in source currency","format":"decimal","example":0},"targetCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Target currency code","example":"GBP"},"targetValue":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Transfer amount in target currency","format":"decimal","example":150},"originalTransferId":{"type":"string","description":"Unique identifier randomly generated per transfer request by the calling client","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"created":{"type":"string","description":"Timestamp when transfer was created.","format":"date-time","example":"2025-10-29T12:28:16.000Z"}}}},"components/schemas/GetThirdPartyTransferResponseContent":{"id":"components/schemas/GetThirdPartyTransferResponseContent","kind":"json-schema","title":"GetThirdPartyTransferResponseContent","data":{"type":"object","description":"Returns the originator transfer object.","properties":{"id":{"type":"integer","description":"Transfer ID","format":"int64","example":16521632},"user":{"type":"integer","description":"Your user ID","format":"int64","example":4342275},"targetAccount":{"type":"integer","description":"Recipient account ID","format":"int64","example":8692237},"sourceAccount":{"type":"integer","description":"Refund recipient account ID","format":"int64","example":1527389},"quote":{"type":"string","description":"Quote ID","example":"8fa9be20-ba43-4b15-abbb-9424e1481050"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer current status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.wise.com/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible statuses."},"children":[]}]}]}],"example":"cancelled"},"rate":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Exchange rate value","format":"decimal","example":0.89},"details":{"$ref":"#/components/schemas/DetailsResponse","description":"Payment Details"},"originator":{"$ref":"#/components/schemas/OriginatorResponse","description":"Data block to capture payment originator details"},"hasActiveIssues":{"type":"boolean","description":"Are there any pending issues which stop executing the transfer?","example":false},"sourceCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Source currency code","example":"EUR"},"sourceValue":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Transfer amount in source currency","format":"decimal","example":0},"targetCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Target currency code","example":"GBP"},"targetValue":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Transfer amount in target currency","format":"decimal","example":150},"originalTransferId":{"type":"string","description":"Unique identifier randomly generated per transfer request by the calling client","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"created":{"type":"string","description":"Timestamp when transfer was created.","format":"date-time","example":"2025-10-29T12:28:16.000Z"}}}},"components/schemas/BalanceRequest":{"id":"components/schemas/BalanceRequest","kind":"json-schema","title":"BalanceRequest","data":{"type":"object","properties":{"balanceId":{"type":"integer","description":"ID of the balance to debit.","format":"int64","example":45678901}}}},"components/schemas/FundingRequestMixin":{"id":"components/schemas/FundingRequestMixin","kind":"json-schema","title":"FundingRequestMixin","data":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"components/schemas/FundingRequestBalance":{"id":"components/schemas/FundingRequestBalance","kind":"json-schema","title":"FundingRequestBalance","data":{"allOf":[{"$ref":"#/components/schemas/BalanceRequest"},{"$ref":"#/components/schemas/FundingRequestMixin"}]}},"components/schemas/TrustedPreFundRequest":{"id":"components/schemas/TrustedPreFundRequest","kind":"json-schema","title":"TrustedPreFundRequest","data":{"type":"object","properties":{"partnerReference":{"type":"string","description":"The transaction/payment identifier in your system. Required for the Cross Currency Bulk Settlement model.","example":"PARTNER-REF-4711"},"status":{"type":"string","description":"Internal status field.","example":"COMPLETE"}}}},"components/schemas/FundingRequestTrustedPreFundBulk":{"id":"components/schemas/FundingRequestTrustedPreFundBulk","kind":"json-schema","title":"FundingRequestTrustedPreFundBulk","data":{"allOf":[{"$ref":"#/components/schemas/TrustedPreFundRequest"},{"$ref":"#/components/schemas/FundingRequestMixin"}]}},"components/schemas/FundingRequestTrustedPreFund":{"id":"components/schemas/FundingRequestTrustedPreFund","kind":"json-schema","title":"FundingRequestTrustedPreFund","data":{"allOf":[{"$ref":"#/components/schemas/TrustedPreFundRequest"},{"$ref":"#/components/schemas/FundingRequestMixin"}]}},"components/schemas/FundingRequest":{"id":"components/schemas/FundingRequest","kind":"json-schema","title":"FundingRequest","data":{"oneOf":[{"$ref":"#/components/schemas/FundingRequestBalance"},{"$ref":"#/components/schemas/FundingRequestTrustedPreFundBulk"},{"$ref":"#/components/schemas/FundingRequestTrustedPreFund"}],"discriminator":{"propertyName":"type","mapping":{"BALANCE":"#/components/schemas/FundingRequestBalance","TRUSTED_PRE_FUND_BULK":"#/components/schemas/FundingRequestTrustedPreFundBulk","TRUSTED_PRE_FUND_TX":"#/components/schemas/FundingRequestTrustedPreFund"}}}},"components/schemas/FundingStatus":{"id":"components/schemas/FundingStatus","kind":"json-schema","title":"FundingStatus","data":{"type":"string","description":"Outcome of a funding attempt.","enum":["CREATED","COMPLETED","REJECTED"]}},"components/schemas/FundingErrorCode":{"id":"components/schemas/FundingErrorCode","kind":"json-schema","title":"FundingErrorCode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each member's documentation notes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values that can produce it and the underlying HTTP status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the complete set of error codes the API can return today. Consumers should treat unknown codes defensively (new codes may be added); a wildcard fallback to a generic 'funding failed' UI is recommended."},"children":[]}]}]}],"enum":["transfer.not-found","transfer.invalid-state","payment.exists","transfer.not-accessible-for-user","balance.unauthorised.missing-security-role","payment.not-found","invalid.request","unexpected.error","payment.option-unavailable","balance.payment-option-unavailable","balance.account-not-found","balance.account-inactive","balance.insufficient-funds","balance.no-balance-for-currency","balance.currency-unsupported","trustedprefundbulk.payment-option-unavailable","trustedprefundtx.payment-option-unavailable"]}},"components/schemas/BalanceResponse":{"id":"components/schemas/BalanceResponse","kind":"json-schema","title":"BalanceResponse","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/FundingStatus","description":"Outcome of the funding attempt."},"errorCode":{"$ref":"#/components/schemas/FundingErrorCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. Present if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status = REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"errorMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form human-readable explanation of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" outcome. Suitable for logging and developer-facing tools; not localised and not safe to surface to end users. May be absent."},"children":[]}]}]}],"example":"Transfer not found"},"balanceTransactionId":{"type":"integer","description":"ID of the balance transaction created to settle the transfer.","format":"int64","example":987654321}}}},"components/schemas/FundingResponseMixin":{"id":"components/schemas/FundingResponseMixin","kind":"json-schema","title":"FundingResponseMixin","data":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]}},"components/schemas/FundingResponseBalance":{"id":"components/schemas/FundingResponseBalance","kind":"json-schema","title":"FundingResponseBalance","data":{"allOf":[{"$ref":"#/components/schemas/BalanceResponse"},{"$ref":"#/components/schemas/FundingResponseMixin"}]}},"components/schemas/TrustedPreFundResponse":{"id":"components/schemas/TrustedPreFundResponse","kind":"json-schema","title":"TrustedPreFundResponse","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/FundingStatus","description":"Outcome of the funding attempt."},"errorCode":{"$ref":"#/components/schemas/FundingErrorCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. Present if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status = REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"errorMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form human-readable explanation of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" outcome. Suitable for logging and developer-facing tools; not localised and not safe to surface to end users. May be absent."},"children":[]}]}]}],"example":"Transfer not found"},"partnerReference":{"type":"string","description":"Partner-supplied reference echoed back.","example":"PARTNER-REF-4711"}}}},"components/schemas/FundingResponseTrustedPreFundBulk":{"id":"components/schemas/FundingResponseTrustedPreFundBulk","kind":"json-schema","title":"FundingResponseTrustedPreFundBulk","data":{"allOf":[{"$ref":"#/components/schemas/TrustedPreFundResponse"},{"$ref":"#/components/schemas/FundingResponseMixin"}]}},"components/schemas/FundingResponseTrustedPreFund":{"id":"components/schemas/FundingResponseTrustedPreFund","kind":"json-schema","title":"FundingResponseTrustedPreFund","data":{"allOf":[{"$ref":"#/components/schemas/TrustedPreFundResponse"},{"$ref":"#/components/schemas/FundingResponseMixin"}]}},"components/schemas/FundingResponse":{"id":"components/schemas/FundingResponse","kind":"json-schema","title":"FundingResponse","data":{"oneOf":[{"$ref":"#/components/schemas/FundingResponseBalance"},{"$ref":"#/components/schemas/FundingResponseTrustedPreFundBulk"},{"$ref":"#/components/schemas/FundingResponseTrustedPreFund"}],"discriminator":{"propertyName":"type","mapping":{"BALANCE":"#/components/schemas/FundingResponseBalance","TRUSTED_PRE_FUND_BULK":"#/components/schemas/FundingResponseTrustedPreFundBulk","TRUSTED_PRE_FUND_TX":"#/components/schemas/FundingResponseTrustedPreFund"}}}},"components/schemas/InvalidRequestErrorErrorPayload":{"id":"components/schemas/InvalidRequestErrorErrorPayload","kind":"json-schema","title":"InvalidRequestErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/UnauthorisedAccessErrorErrorPayload":{"id":"components/schemas/UnauthorisedAccessErrorErrorPayload","kind":"json-schema","title":"UnauthorisedAccessErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/EntityNotFoundErrorErrorPayload":{"id":"components/schemas/EntityNotFoundErrorErrorPayload","kind":"json-schema","title":"EntityNotFoundErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/PaymentAlreadyExistsErrorErrorPayload":{"id":"components/schemas/PaymentAlreadyExistsErrorErrorPayload","kind":"json-schema","title":"PaymentAlreadyExistsErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/UnsupportedOperationErrorErrorPayload":{"id":"components/schemas/UnsupportedOperationErrorErrorPayload","kind":"json-schema","title":"UnsupportedOperationErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/UnexpectedErrorErrorPayload":{"id":"components/schemas/UnexpectedErrorErrorPayload","kind":"json-schema","title":"UnexpectedErrorErrorPayload","data":{"type":"string","example":"transfer.not-found"}},"components/schemas/payment":{"id":"components/schemas/payment","kind":"json-schema","title":"Payment","data":{"title":"Payment","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Payment ID","example":50000000},"method":{"type":"string","description":"The payment method used to pay for the transfer","example":"BANK_TRANSFER"},"pricingVariant":{"type":["string","null"],"description":"The qualifier that allows to apply different pricing policy within the same payment method. Often the value might be the payment method itself","example":null},"amount":{"type":"number","description":"Transfer source amount","example":1000},"currency":{"type":"string","description":"Transfer source currency","example":"GBP"},"timeCreated":{"type":"string","format":"date-time","description":"Date of when payment was created","example":"2020-01-01T12:30:15.000Z"},"timeUpdated":{"type":"string","format":"date-time","description":"Date of when payment was updated","example":"2020-01-01T12:30:15.000Z"}}}},"components/schemas/IncomingTransferState":{"id":"components/schemas/IncomingTransferState","kind":"json-schema","title":"IncomingTransferState","data":{"type":"string","description":"Current state of the incoming transfer. Additional states will be added in the future.","enum":["CREDITED"]}},"components/schemas/CreditTransferType":{"id":"components/schemas/CreditTransferType","kind":"json-schema","title":"CreditTransferType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - End-user or corporate payment where at least one side (debtor or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditor) is a non-financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FI_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct bank-to-bank settlement, liquidity movement, or cover transfer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where both parties are financial institutions."},"children":[]}]}]}]}],"enum":["CUSTOMER_CREDIT_TRANSFER","FI_CREDIT_TRANSFER"]}},"components/schemas/IncomingTransferScheme":{"id":"components/schemas/IncomingTransferScheme","kind":"json-schema","title":"IncomingTransferScheme","data":{"type":"string","enum":["SWIFT","CHAPS","SEPA","SEPA_INSTANT","ACH","FEDWIRE","FEDNOW","FASTER_PAYMENTS","BACS","WISE_NETWORK","EUR_T2"]}},"components/schemas/Iso20022Address":{"id":"components/schemas/Iso20022Address","kind":"json-schema","title":"Iso20022Address","data":{"type":"object","description":"An ISO 20022 structured address with optional free-form address lines.","properties":{"streetName":{"type":"string","description":"Street name","example":"Clifton Street, London"},"buildingNumber":{"type":"string","description":"Building number","example":"65"},"townName":{"type":"string","description":"City or town","example":"London"},"postCode":{"type":"string","description":"Postal or ZIP code","example":"EC2A 4JE"},"countrySubDivision":{"type":"string","description":"State, province, or region","example":"Greater London"},"country":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code","example":"GB"},"addressLines":{"type":"array","items":{"type":"string"},"maxItems":2,"description":"Address lines. May be empty; up to two lines can be populated alongside structured fields.","example":["1st Floor, Worship Square","EV2A 4JE"]}},"required":["addressLines","country","townName"]}},"components/schemas/AccountInfo":{"id":"components/schemas/AccountInfo","kind":"json-schema","title":"AccountInfo","data":{"type":"object","properties":{"number":{"type":"string","maxLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account identifier — IBAN, BBAN, or other scheme-specific account number."},"children":[]}]}]}],"example":"GB29NWBK60161331926819"}},"required":["number"]}},"components/schemas/NationalCodeType":{"id":"components/schemas/NationalCodeType","kind":"json-schema","title":"NationalCodeType","data":{"type":"string","enum":["ABA","SORT_CODE"]}},"components/schemas/FinancialInstitution":{"id":"components/schemas/FinancialInstitution","kind":"json-schema","title":"FinancialInstitution","data":{"type":"object","properties":{"bic":{"type":"string","maxLength":11,"minLength":8,"description":"SWIFT BIC (Business Identifier Code) of the financial institution.","example":"TRWIGB2L"},"nationalCode":{"type":"string","description":"Domestic clearing system membership identifier (e.g. UK sort code, US ABA routing number).","example":"230801"},"nationalCodeType":{"$ref":"#/components/schemas/NationalCodeType","description":"Identifies the domestic clearing system the nationalCode belongs to."},"name":{"type":"string","maxLength":140,"description":"Name of the financial institution.","example":"Wise Payments Ltd"},"address":{"$ref":"#/components/schemas/Iso20022Address","description":"Postal address. Fields are optional and populated based on what the payment rail provides."}}}},"components/schemas/Debtor":{"id":"components/schemas/Debtor","kind":"json-schema","title":"Debtor","data":{"type":"object","properties":{"name":{"type":"string","maxLength":140,"description":"Full name of the debtor.","example":"Sarah Jenkins"},"address":{"$ref":"#/components/schemas/Iso20022Address","description":"Address of the debtor"},"account":{"$ref":"#/components/schemas/AccountInfo","description":"Account details of the debtor"},"agent":{"$ref":"#/components/schemas/FinancialInstitution","description":"Financial institution acting as the debtor's agent"}},"required":["name"]}},"components/schemas/Creditor":{"id":"components/schemas/Creditor","kind":"json-schema","title":"Creditor","data":{"type":"object","properties":{"name":{"type":"string","maxLength":140,"description":"Full name of the creditor.","example":"Sarah Jenkins"},"address":{"$ref":"#/components/schemas/Iso20022Address","description":"Address of the creditor"},"account":{"$ref":"#/components/schemas/AccountInfo","description":"Account details of the creditor"},"agent":{"$ref":"#/components/schemas/FinancialInstitution","description":"Financial institution acting as the creditor's agent"}},"required":["account","name"]}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"type":"object","description":"A monetary value paired with its currency code.","properties":{"value":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Monetary value","format":"decimal","example":1000},"currency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code","example":"USD"}},"required":["currency","value"]}},"components/schemas/Amounts":{"id":"components/schemas/Amounts","kind":"json-schema","title":"Amounts","data":{"type":"object","properties":{"instructed":{"$ref":"#/components/schemas/Money","description":"The original amount instructed by the debtor. When not specified by scheme, it equals interbankSettlement."},"interbankSettlement":{"$ref":"#/components/schemas/Money","description":"The amount settled between the instructing and instructed agent on the final interbank leg."},"credited":{"$ref":"#/components/schemas/Money","description":"The amount credited to the creditor's Wise balance. Computed as interbankSettlement, after any FX conversion and Wise fees."}},"required":["credited","instructed","interbankSettlement"]}},"components/schemas/ChargeBearer":{"id":"components/schemas/ChargeBearer","kind":"json-schema","title":"ChargeBearer","data":{"type":"string","enum":["DEBTOR","CREDITOR","SHARED","SERVICE_LEVEL"]}},"components/schemas/WiseFeeType":{"id":"components/schemas/WiseFeeType","kind":"json-schema","title":"WiseFeeType","data":{"type":"string","enum":["CONVERSION","FIXED_HANDLING","OTHER"]}},"components/schemas/WiseFee":{"id":"components/schemas/WiseFee","kind":"json-schema","title":"WiseFee","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/WiseFeeType","description":"Category of the Wise fee. Additional fee types will be added in future versions."},"value":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Decimal fee amount.","format":"decimal","example":7.25},"currency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code.","example":"EUR"}},"required":["currency","type","value"]}},"components/schemas/CorrespondentFee":{"id":"components/schemas/CorrespondentFee","kind":"json-schema","title":"CorrespondentFee","data":{"type":"object","properties":{"value":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Decimal fee amount deducted by the correspondent bank.","format":"decimal","example":15},"currency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code.","example":"USD"},"agent":{"$ref":"#/components/schemas/FinancialInstitution","description":"The financial institution that deducted this fee. Omitted when the charging agent is not identified in the payment message."}},"required":["currency","value"]}},"components/schemas/Fees":{"id":"components/schemas/Fees","kind":"json-schema","title":"Fees","data":{"type":"object","properties":{"wise":{"type":"array","items":{"$ref":"#/components/schemas/WiseFee"},"description":"Fees charged by Wise (e.g. conversion fee, handling fee). Empty array when no Wise fees apply."},"correspondent":{"type":"array","items":{"$ref":"#/components/schemas/CorrespondentFee"},"description":"Fees deducted by correspondent or intermediary banks before the funds reached Wise. Each\nentry includes the charging agent when available in the pacs message. Array is empty where\nthere are no charges."}},"required":["correspondent","wise"]}},"components/schemas/GetIncomingTransferResponseContent":{"id":"components/schemas/GetIncomingTransferResponseContent","kind":"json-schema","title":"GetIncomingTransferResponseContent","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the incoming transfer. UUID-formatted string.","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"profileId":{"type":"integer","description":"Profile ID of the balance owner.","format":"int64","example":12345678},"balanceId":{"type":"string","description":"Balance ID associated with the incoming transfer. This is the balance that was credited.","example":"555555"},"accountDetailsId":{"type":"string","description":"Account details ID that received the incoming transfer. A balance may have multiple account\ndetails (e.g. multiple IBANs). This identifies the specific one that was credited. Omitted\nwhen the payment was received via correspondent model.","example":"987654"},"state":{"$ref":"#/components/schemas/IncomingTransferState","description":"Current state of the incoming transfer. Additional states will be added in the future."},"creditTransferType":{"$ref":"#/components/schemas/CreditTransferType","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - End-user or corporate payment where at least one side (debtor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or creditor) is a non-financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FI_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Direct bank-to-bank settlement, liquidity movement, or cover"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer where both parties are financial institutions."},"children":[]}]}]}]}]},"scheme":{"$ref":"#/components/schemas/IncomingTransferScheme","description":"The payment scheme through which the incoming transfer was received."},"endToEndId":{"type":"string","maxLength":35,"description":"End-to-end identifier assigned by the debtor for reconciliation purposes. Omitted when not\nprovided by the debtor.","example":"INVOICE-2026-998"},"uetr":{"type":"string","description":"Universal End-to-End Transaction Reference. A globally unique identifier (UUID v4) assigned\nby the debtor agent to track the payment across the entire chain. UUID-formatted string.","format":"uuid","example":"123e4567-e89b-42d3-a456-426614174000"},"unstructuredReference":{"type":"string","maxLength":140,"description":"Unstructured remittance information provided by the debtor. Free-text field carried through\nthe payment rail.","example":"/RFB/INV-2025-001"},"creditedTime":{"type":"string","description":"Timestamp when the incoming transfer was credited to the balance.","format":"date-time","example":"2025-08-21T12:34:56.000Z"},"debtor":{"$ref":"#/components/schemas/Debtor","description":"The debtor (ordering party) of the incoming transfer."},"creditor":{"$ref":"#/components/schemas/Creditor","description":"The creditor (beneficiary) of the incoming transfer."},"amounts":{"$ref":"#/components/schemas/Amounts","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment amount waterfall representing the flow of funds: instructed → interbankSettlement → credited."},"children":[]}]}]}]},"exchangeRate":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wise's effective FX rate applied to this incoming transfer (source currency → target balance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency) as a decimal number. 1 when no conversion was needed."},"children":[]}]}]}],"format":"decimal","example":0.6325},"chargeBearer":{"$ref":"#/components/schemas/ChargeBearer","description":"Charge bearer code indicating who pays the transaction fees. Omitted if not specified in the payment message."},"previousInstructingAgents":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInstitution"},"description":"Financial institutions that previously instructed this payment (the historical chain the\npayment passed through before reaching Wise). Ordered by position in the chain."},"fees":{"$ref":"#/components/schemas/Fees","description":"Breakdown of fees applied to the incoming transfer. Contains both Wise fees and\ncorrespondent/intermediary bank fees."}},"required":["amounts","balanceId","creditedTime","creditor","debtor","exchangeRate","fees","id","previousInstructingAgents","profileId","scheme","state"]}},"components/schemas/GpiTrackingIdentifierType":{"id":"components/schemas/GpiTrackingIdentifierType","kind":"json-schema","title":"GpiTrackingIdentifierType","data":{"type":"string","description":"The type of identifier used to look up a transfer's GPI tracking data.","enum":["UETR","TRANSFER_ID"]}},"components/schemas/LookupGpiTrackingRequestContent":{"id":"components/schemas/LookupGpiTrackingRequestContent","kind":"json-schema","title":"LookupGpiTrackingRequestContent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify the transfer to look up by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UETR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"identifierType":{"$ref":"#/components/schemas/GpiTrackingIdentifierType","description":"The type of identifier used to look up the transfer."},"identifier":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The UETR or Wise transfer ID of the transfer to look up, matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a UUID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"97ed4827-7b6f-4491-a206-42bcf859a919"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UETR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a positive integer (int64) (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16521632"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"97ed4827-7b6f-4491-a206-42bcf859a919"}},"required":["identifier","identifierType"]}},"components/schemas/GpiTrackingSettlementMethod":{"id":"components/schemas/GpiTrackingSettlementMethod","kind":"json-schema","title":"GpiTrackingSettlementMethod","data":{"type":"object","description":"Settlement method reported for an ACSP sub-status.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement method code, passed through as a SWIFT gpi settlement method code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INGA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLRG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"INGA"},"clearingSystem":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clearing system, present when the settlement method is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLRG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CHI"}}}},"components/schemas/GpiTrackingStatusReason":{"id":"components/schemas/GpiTrackingStatusReason","kind":"json-schema","title":"GpiTrackingStatusReason","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT gpi ACSP sub-status (transaction_status_reason)."},"children":[]}]}]}],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-status code, passed through as a SWIFT gpi transaction status reason code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G003"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G004"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G006"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"G002"},"settlementMethod":{"$ref":"#/components/schemas/GpiTrackingSettlementMethod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement method. Present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G006"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"instructedAgent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIC the transaction was forwarded to. Present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G006"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"TSPABEB0002"},"chargeBearer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge bearer code. Present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G006"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SHAR"}}}},"components/schemas/GpiTrackingMoney":{"id":"components/schemas/GpiTrackingMoney","kind":"json-schema","title":"GpiTrackingMoney","data":{"type":"object","description":"A monetary value represented using the GPI tracking wire format.","properties":{"amount":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Non-negative monetary amount.","format":"decimal","example":250.45},"currency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code.","example":"EUR"}}}},"components/schemas/GpiTrackingCancellationStatus":{"id":"components/schemas/GpiTrackingCancellationStatus","kind":"json-schema","title":"GpiTrackingCancellationStatus","data":{"type":"string","description":"Cancellation status of a tracked transaction.","enum":["CANCELLED","PENDING_CANCELLATION","CANCELLATION_REJECTED"]}},"components/schemas/GpiTrackingCancellationRequestStatus":{"id":"components/schemas/GpiTrackingCancellationRequestStatus","kind":"json-schema","title":"GpiTrackingCancellationRequestStatus","data":{"type":"object","description":"Cancellation request status reported for an event.","properties":{"reasonCode":{"type":"string","description":"Cancellation reason code, passed through as a SWIFT gpi cancellation reason code. Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists.","example":"CUST"},"indemnityAgreement":{"type":"boolean","description":"Whether an indemnity agreement applies to the cancellation request.","example":false}}}},"components/schemas/GpiTrackingCancellationResponseStatus":{"id":"components/schemas/GpiTrackingCancellationResponseStatus","kind":"json-schema","title":"GpiTrackingCancellationResponseStatus","data":{"type":"object","description":"Cancellation response status reported for an event.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation response code, passed through as a SWIFT gpi cancellation response code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CNCL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cancelled), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDCR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pending), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"RJCR"},"reasonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation response reason code, passed through as a SWIFT gpi cancellation response reason code. Present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDCR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"LEGL"}}}},"components/schemas/GpiTrackingCharge":{"id":"components/schemas/GpiTrackingCharge","kind":"json-schema","title":"GpiTrackingCharge","data":{"type":"object","description":"A charge applied while processing the transaction.","properties":{"amount":{"$ref":"#/components/schemas/GpiTrackingMoney","description":"Charge amount."},"bic":{"type":"string","description":"BIC of the charging agent.","example":"TRCKCHZ0XXX"},"name":{"type":"string","description":"Name of the charging agent.","example":"Example Correspondent Bank"}}}},"components/schemas/GpiTrackingEvent":{"id":"components/schemas/GpiTrackingEvent","kind":"json-schema","title":"GpiTrackingEvent","data":{"type":"object","description":"An event reported for a tracked transaction.","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status conveyed by this event, passed through as a SWIFT gpi transaction status code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (accepted, settlement in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (accepted, settlement completed), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"ACSP"},"statusReason":{"$ref":"#/components/schemas/GpiTrackingStatusReason","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-status detail, present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"statusTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this status was reached. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","example":"2023-09-18T12:13:33.314Z"},"confirmedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the funds were made available to the creditor. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","example":"2023-09-18T12:13:33.314Z"},"confirmedAmount":{"$ref":"#/components/schemas/GpiTrackingMoney","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount credited to the creditor's account. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rejectionReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejection reason code, passed through as a SWIFT gpi rejection reason code (ISO 20022 external return/reason code). Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Known values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (closed account number), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (blocked account), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AM09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (wrong amount), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BE01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inconsistent with end customer), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RR04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"AC04"},"instructedAmount":{"$ref":"#/components/schemas/GpiTrackingMoney","description":"Amount as instructed at this hop."},"settledAmount":{"$ref":"#/components/schemas/GpiTrackingMoney","description":"Amount as settled at this hop."},"amountInconsistency":{"type":"boolean","description":"Whether instructed and settled amounts are inconsistent.","example":false},"settlementDate":{"type":"string","description":"Settlement date of this event.","format":"date","example":"2023-09-18"},"sourceCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Source currency of the exchange, if any.","example":"EUR"},"targetCurrency":{"type":"string","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","description":"Target currency of the exchange, if any.","example":"GBP"},"exchangeRate":{"type":"number","minimum":0,"exclusiveMinimum":0,"description":"Exchange rate applied between the source and target currencies.","format":"decimal","example":0.8501},"chargeBearer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge bearer indicator, passed through as a SWIFT gpi charge bearer code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SLEV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"SHAR"},"endToEndId":{"type":"string","description":"End-to-end identifier.","example":"802.0GC9A9E78ABD"},"messageNameIdentification":{"type":"string","description":"Message name identification (ISO 20022 message type).","example":"pacs.008.001.08"},"instructionId":{"type":"string","description":"Instruction identifier.","example":"0918121252010240"},"returnReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return reason code associated with this event, passed through as a SWIFT gpi return reason code (ISO 20022 external return/reason code). Known values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (closed account number), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (blocked account), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AM09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (wrong amount), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BE01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inconsistent with end customer), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RR04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"AC04"},"eventType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the tracking event, passed through as a SWIFT gpi tracker event type code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STATUS_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLATION_REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLATION_RESPONSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLATION_REQUEST_STATUS_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"CANCELLATION_RESPONSE"},"eventTarget":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target of the tracking event, passed through as a SWIFT gpi tracker event target code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSFER_RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSFER_COVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSFER_COVER_RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER_RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER_COVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER_COVER_RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"CREDIT_TRANSFER"},"cancellationRequestStatus":{"$ref":"#/components/schemas/GpiTrackingCancellationRequestStatus","description":"Cancellation request status conveyed by this event."},"cancellationResponseStatus":{"$ref":"#/components/schemas/GpiTrackingCancellationResponseStatus","description":"Cancellation response status conveyed by this event."},"cancellationRequestTrackingStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation request tracking status conveyed by this event, passed through as a SWIFT gpi cancellation request tracking status code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S003"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S004"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"S004"},"serviceLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service level of the transaction, passed through as a SWIFT gpi service level code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G004"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"G009"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"G002"},"instructedAgent":{"type":"string","description":"Instructed agent BIC.","example":"TSPABEB0002"},"from":{"type":"string","description":"Sending agent BIC.","example":"TRCKCHZ0XXX"},"to":{"type":"string","description":"Receiving agent BIC.","example":"TSPABEB0002"},"trackerInformingParty":{"type":"string","description":"Party informing the tracker.","example":"ZYZAGB20XXX"},"debtorAgent":{"type":"string","description":"Debtor agent BIC.","example":"DEUTDEFFXXX"},"creditorAgent":{"type":"string","description":"Creditor agent BIC.","example":"BARCGB22XXX"},"instructingReimbursementAgent":{"type":"string","description":"Instructing reimbursement agent BIC.","example":"CHASUS33XXX"},"previousInstructingAgent1":{"type":"string","description":"Previous instructing agent 1 BIC.","example":"BOFAUS3NXXX"},"previousInstructingAgent2":{"type":"string","description":"Previous instructing agent 2 BIC.","example":"CITIUS33XXX"},"previousInstructingAgent3":{"type":"string","description":"Previous instructing agent 3 BIC.","example":"NWBKGB2LXXX"},"intermediaryAgent1":{"type":"string","description":"Intermediary agent 1 BIC.","example":"DEUTDEFFXXX"},"intermediaryAgent2":{"type":"string","description":"Intermediary agent 2 BIC.","example":"BNPAFRPPXXX"},"intermediaryAgent3":{"type":"string","description":"Intermediary agent 3 BIC.","example":"INGBNL2AXXX"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/GpiTrackingCharge"},"description":"Charges applied at this hop. Omitted when there are none."},"eventCreationTime":{"type":"string","description":"When this event was created.","format":"date-time","example":"2023-09-18T12:13:33.348Z"}}}},"components/schemas/GpiTracking":{"id":"components/schemas/GpiTracking","kind":"json-schema","title":"GpiTracking","data":{"type":"object","description":"GPI tracking data for a transaction.","properties":{"uetr":{"type":"string","description":"The UETR of the tracked transaction.","example":"97ed4827-7b6f-4491-a206-42bcf859a919"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overall tracking status of the transaction, passed through as a SWIFT gpi transaction status code. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (accepted, settlement in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (accepted, settlement completed), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rejected). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"ACSP"},"statusReason":{"$ref":"#/components/schemas/GpiTrackingStatusReason","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-status detail, present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"statusTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this status was reached. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACSP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","example":"2023-09-18T12:13:33.314Z"},"confirmedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the funds were made available to the creditor. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time","example":"2023-09-18T12:13:33.314Z"},"confirmedAmount":{"$ref":"#/components/schemas/GpiTrackingMoney","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount credited to the creditor's account. Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rejectionReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejection reason code, passed through as a SWIFT gpi rejection reason code (ISO 20022 external return/reason code). Present when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RJCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Known values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (closed account number), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (blocked account), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AM09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (wrong amount), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BE01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inconsistent with end customer), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RR04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"AC04"},"cancellationStatus":{"$ref":"#/components/schemas/GpiTrackingCancellationStatus","description":"Cancellation status, when a cancellation has been requested or resolved."},"returnReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return reason code, present when the transaction was returned or rejected, passed through as a SWIFT gpi return reason code (ISO 20022 external return/reason code). Known values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (closed account number), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AC06"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (blocked account), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AM09"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (wrong amount), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BE01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (inconsistent with end customer), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RR04"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (regulatory reason). Additional values may be introduced by SWIFT gpi; see the SWIFT gpi code lists."},"children":[]}]}]}],"example":"AC04"},"initiatedAt":{"type":"string","description":"When transaction tracking was initiated.","format":"date-time","example":"2023-09-18T12:05:50Z"},"completedAt":{"type":"string","description":"When the transaction reached a completed state.","format":"date-time","example":"2023-09-18T12:13:33.314Z"},"lastUpdatedAt":{"type":"string","description":"When the tracking record was last updated.","format":"date-time","example":"2023-09-18T12:13:33.314Z"},"events":{"type":"array","items":{"$ref":"#/components/schemas/GpiTrackingEvent"},"description":"Ordered tracking events, latest first."}}}},"components/schemas/LookupGpiTrackingResponseContent":{"id":"components/schemas/LookupGpiTrackingResponseContent","kind":"json-schema","title":"LookupGpiTrackingResponseContent","data":{"type":"object","description":"The matching GPI tracking transactions.","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/GpiTracking"},"description":"The matching GPI tracking transactions."}}}},"components/schemas/user":{"id":"components/schemas/user","kind":"json-schema","title":"User","data":{"title":"User","type":"object","x-tags":["user"],"description":"Represents a Wise user account.","properties":{"id":{"type":"integer","format":"int64","description":"User ID.","example":101},"name":{"type":["string","null"],"description":"User's full name.","example":"Example Person"},"email":{"type":"string","description":"User's email.","example":"person@example.com"},"active":{"type":"boolean","description":"If user is active or not.","example":true},"details":{"type":["object","null"],"description":"User details.","properties":{"firstName":{"type":"string","description":"User's first name.","example":"Example"},"lastName":{"type":"string","description":"User's last name.","example":"Person"},"phoneNumber":{"type":"string","description":"Phone number.","example":"+37111111111"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth (YYYY-MM-DD).","example":"1977-01-01"},"occupation":{"type":"string","description":"Person's occupation.","example":""},"avatar":{"type":"string","description":"Link to person avatar image.","example":"https://lh6.googleusercontent.com/photo.jpg"},"primaryAddress":{"type":"integer","format":"int64","description":"Address object ID to use in addresses endpoints.","example":111},"address":{"type":"object","description":"User's address.","properties":{"countryCode":{"type":"string","description":"Address country code in 2 digits. \"US\" for example.","example":"EE"},"firstLine":{"type":"string","description":"Address first line.","example":"Road 123"},"postCode":{"type":"string","description":"Address post code.","example":"11111"},"city":{"type":"string","description":"Address city name.","example":"Tallinn"},"state":{"type":"string","description":"Address state code. Required if country is US, CA, AU, or BR.","example":""},"occupation":{"type":"string","description":"User occupation. Required for US, CA, JP.","example":""}}}}}}}},"components/schemas/subscription":{"id":"components/schemas/subscription","kind":"json-schema","title":"Subscription","data":{"title":"Subscription","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID that uniquely identifies the subscription.","example":"72195556-e5cb-495e-a010-b37a4f2a3043"},"name":{"type":"string","description":"A custom name for your webhook to ease with identification.","example":"Webhook Subscription #1"},"trigger_on":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event type this subscription is listening for. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"transfers#state-change"},"delivery":{"type":"object","properties":{"version":{"type":"string","description":"The event representation semantic version.","example":"4.0.0"},"url":{"type":"string","description":"The URL where your server will be listening for events.","example":"https://your.webhook.url/12345"}}},"scope":{"type":"object","properties":{"domain":{"type":"string","description":"Scope of this subscription (e.g. \"application\" or \"profile\").","example":"application"},"id":{"type":"string","description":"ID associated with the scope (client key or profile ID).","example":""}}},"created_by":{"type":"object","properties":{"type":{"type":"string","description":"Creator type (e.g. \"application\" or \"user\").","example":"application"},"id":{"type":"string","description":"ID of the creator.","example":""}}},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the subscription was created.","example":"2019-10-10T13:55:57Z"}}}},"components/schemas/subscription-request":{"id":"components/schemas/subscription-request","kind":"json-schema","title":"Subscription Request","data":{"title":"Subscription Request","type":"object","required":["name","trigger_on","delivery"],"properties":{"name":{"type":"string","description":"A custom name for your webhook to ease with identification.","example":"Webhook Subscription #1"},"trigger_on":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook-event"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose from a list of available events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"transfers#state-change"},"delivery":{"type":"object","required":["version","url"],"properties":{"version":{"type":"string","description":"The event representation semantic version.","example":"4.0.0"},"url":{"type":"string","description":"The URL where your server will be listening for events.","example":"https://your.webhook.url/12345"}}}}}},"components/schemas/test-notification":{"id":"components/schemas/test-notification","kind":"json-schema","title":"Test Notification","data":{"title":"Test Notification","type":"object","properties":{"delivery_id":{"type":"string","format":"uuid","description":"ID of the delivery that was queued for sending.","example":"4a6b9810-4279-4de5-8d8d-1a6cf3b92a75"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the test notification was created.","example":"2019-03-28T11:22:33Z"}}}},"components/schemas/v4.0.0":{"id":"components/schemas/v4.0.0","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#active-cases"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type","example":"transfer"},"id":{"type":"integer","format":"int64","description":"Transfer ID","example":111},"profile_id":{"type":"integer","format":"int64","description":"Profile ID of the transfer owner.","example":222},"account_id":{"type":"integer","format":"int64","description":"Recipient account ID","example":333}}},"active_cases":{"type":"array","items":{"type":"string"},"description":"Ongoing issues related to the transfer.","example":["deposit_amount_less_invoice"]}}}}}},"components/schemas/v2.0.0":{"id":"components/schemas/v2.0.0","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"transfers#active-cases"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type","example":"transfer"},"id":{"type":"integer","format":"int64","description":"Transfer ID","example":111},"profile_id":{"type":"integer","format":"int64","description":"Profile ID of the transfer owner.","example":222},"account_id":{"type":"integer","format":"int64","description":"Recipient account ID.","example":333}}},"active_cases":{"type":"array","items":{"type":"string"},"description":"Ongoing issues related to the transfer.","example":["deposit_amount_less_invoice"]}}}}}},"components/schemas/v4.0.0-2":{"id":"components/schemas/v4.0.0-2","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#refund"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"transfer"},"id":{"type":"integer","format":"int64","description":"ID of the transfer.","example":111},"profile_id":{"type":"integer","format":"int64","description":"Identifies the Wise profile associated with this refund.","example":222},"account_id":{"type":"integer","format":"int64","description":"ID referring to the initial beneficiary of the payment. The ultimate beneficiary is the sender the funds are being refunded to.","example":333},"refund_amount":{"type":"number","format":"double","description":"The total amount that was refunded to the customer. Includes any applicable fees.","example":5000},"refund_currency":{"type":"string","description":"The three-letter ISO currency code representing the currency in which the refund was issued.","example":"EUR"}}},"occurred_at":{"type":"string","format":"date-time","description":"The date and time the refund was triggered.","example":"2024-01-01T12:34:56.789Z"}}}}}},"components/schemas/v2.0.0-2":{"id":"components/schemas/v2.0.0-2","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#refund"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"transfer"},"id":{"type":"integer","format":"int64","description":"ID of the transfer.","example":111},"profile_id":{"type":"integer","format":"int64","description":"Identifies the Wise profile associated with this refund.","example":222},"account_id":{"type":"integer","format":"int64","description":"ID referring to the initial beneficiary of the payment. The ultimate beneficiary is the sender the funds are being refunded to.","example":333},"refund_amount":{"type":"number","format":"double","description":"The total amount that was refunded to the customer. Includes any applicable fees.","example":5000},"refund_currency":{"type":"string","description":"The three-letter ISO currency code representing the currency in which the refund was issued.","example":"EUR"}}},"occurred_at":{"type":"string","format":"date-time","description":"The date and time the refund was triggered.","example":"2024-01-01T12:34:56Z"}}}}}},"components/schemas/v5.0.0":{"id":"components/schemas/v5.0.0","kind":"json-schema","title":"Schema version 5.0.0","data":{"title":"Schema version 5.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["5.0.0"],"example":"5.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#payout-failure"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-10T10:17:28.123Z"},"data":{"type":"object","properties":{"transfer_id":{"type":"integer","format":"int64","description":"ID of the transfer.","example":111},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that initiated the transfer.","example":222},"failure_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the failure error. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available codes."},"children":[]}]}]}],"example":"TECHNICAL_ISSUE_RETRYABLE","enum":["ACCOUNT_BLOCKED","ACCOUNT_CLOSED","ACCOUNT_DOES_NOT_EXIST","ACCOUNT_FROZEN","ACCOUNT_LIMIT_REACHED","BUSINESS_PAYMENTS_FORBIDDEN","CANNOT_ACCEPT_FROM_3RD_PARTY","CREDITING_ACCOUNT_FORBIDDEN","DUPLICATE_ENTRY","EXTERNAL_IDENTIFIER_DETAILS_HAVE_CHANGED","FUNDS_NOT_EXPECTED_RETURNED","MANDATE_NOT_FILLED_IN","REASON_NOT_SPECIFIED","REQUEST_FOR_INFORMATION_EXPIRED","RETURN_REQUESTED_BY_RECIPIENT","SENDER_REQUESTED_TO_CANCEL","TAX_ID_NOT_MATCHING","TAX_ID_SUSPENDED","TECHNICAL_ISSUE","TECHNICAL_ISSUE_RETRYABLE","WRONG_ACCOUNT_DETAILS","WRONG_ACCOUNT_NUMBER","WRONG_ACCOUNT_TYPE","WRONG_BANK_CODE","WRONG_BRANCH_CODE","WRONG_CARD_NUMBER","WRONG_CARD_TYPE","WRONG_CURRENCY","WRONG_ID_NUMBER","WRONG_NAME","WRONG_PHONE_NUMBER","WRONG_REFERENCE","WRONG_PAYMENT_PURPOSE","WRONG_RUT_NUMBER"]},"failure_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the failure code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available descriptions."},"children":[]}]}]}],"example":"Payment failed due to a technical issue, Wise will retry"},"occurred_at":{"type":"string","format":"date-time","description":"When the state change occurred.","example":"2023-08-10T10:17:23.123Z"}}}}}},"components/schemas/v4.0.0-3":{"id":"components/schemas/v4.0.0-3","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#payout-failure"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-10T10:17:28.123Z"},"data":{"type":"object","properties":{"transfer_id":{"type":"integer","format":"int64","description":"ID of the transfer.","example":111},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that initiated the transfer.","example":222},"failure_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the failure error. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available codes."},"children":[]}]}]}],"example":"WRONG_ID_NUMBER"},"failure_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the failure code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available descriptions."},"children":[]}]}]}],"example":"Invalid recipient's ID document number"},"occurred_at":{"type":"string","format":"date-time","description":"When the state change occurred.","example":"2023-08-10T10:17:23.123Z"}}}}}},"components/schemas/v2.0.0-3":{"id":"components/schemas/v2.0.0-3","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier.","example":"transfers#payout-failure"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-10T10:17:28Z"},"data":{"type":"object","properties":{"transfer_id":{"type":"integer","format":"int64","description":"ID of the transfer.","example":111},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that initiated the transfer.","example":222},"failure_reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the failure error. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available codes."},"children":[]}]}]}],"example":"WRONG_ID_NUMBER"},"failure_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the failure code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking/payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available descriptions."},"children":[]}]}]}],"example":"Invalid recipient's ID document number"},"occurred_at":{"type":"string","format":"date-time","description":"When the state change occurred.","example":"2023-08-10T10:17:23.000+00:00"}}}}}},"components/schemas/v4.0.0-4":{"id":"components/schemas/v4.0.0-4","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"transfers#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type","example":"transfer"},"id":{"type":"integer","format":"int64","description":"Transfer ID","example":111},"profile_id":{"type":"integer","format":"int64","description":"Profile ID of the transfer owner.","example":222},"account_id":{"type":"integer","format":"int64","description":"Recipient account ID","example":333}}},"current_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current transfer status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"processing"},"previous_state":{"type":["string","null"],"description":"Previous transfer status. Note that this will be null for newly created transfers.","example":"incoming_payment_waiting"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the state change occurred.","example":"2020-01-01T12:34:56.789Z"}}}}}},"components/schemas/v2.0.0-4":{"id":"components/schemas/v2.0.0-4","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"transfers#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type","example":"transfer"},"id":{"type":"integer","format":"int64","description":"Transfer ID","example":111},"profile_id":{"type":"integer","format":"int64","description":"Profile ID of the transfer owner.","example":222},"account_id":{"type":"integer","format":"int64","description":"Recipient account ID","example":333}}},"current_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current transfer status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/send-money/tracking-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"processing"},"previous_state":{"type":["string","null"],"description":"Previous transfer status. Note that this will be null for newly created transfers.","example":"incoming_payment_waiting"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the state change occurred.","example":"2020-01-01T12:34:56Z"}}}}}},"components/schemas/v4.0.0-5":{"id":"components/schemas/v4.0.0-5","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01989c58-7171-7276-9a4c-c9b4cefc0897"},"event_type":{"type":"string","description":"Event type identifier","example":"account-details-order#order-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2025-08-08T07:49:31.123Z"},"data":{"type":"object","properties":{"creation_time":{"type":"string","format":"date-time","description":"When the order was created.","example":"2025-08-08T07:49:27.456Z"},"currency":{"type":"string","description":"Currency code for the account details order.","example":"CAD"},"is_account_details_issued":{"type":"boolean","description":"Whether account details have been issued for this order.","example":false},"modification_time":{"type":"string","format":"date-time","description":"When the order was last modified.","example":"2025-08-08T07:49:30.789Z"},"order_id":{"type":"string","description":"Unique identifier for the account details order.","example":"01989c58-45e4-71dd-9373-7d999e992f99"},"order_status":{"type":"string","description":"Current status of the order","enum":["PENDING_USER","PENDING_TW","REQUIREMENTS_FULFILLED","DONE"],"example":"REQUIREMENTS_FULFILLED"},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile associated with this order.","example":28835473},"requirements":{"type":"array","description":"List of requirements for this order.","items":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the individual requirement ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DONE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PENDING\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)"},"children":[]}]}]}],"example":"DONE"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of requirement ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"VERIFICATION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"VERIFICATION"}}}}}}}}},"components/schemas/v2.0.0-5":{"id":"components/schemas/v2.0.0-5","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01989c58-7171-7276-9a4c-c9b4cefc0897"},"event_type":{"type":"string","description":"Event type identifier","example":"account-details-order#order-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2025-08-08T07:49:31Z"},"data":{"type":"object","properties":{"creation_time":{"type":"string","format":"date-time","description":"When the order was created.","example":"2025-08-08T07:49:27Z"},"currency":{"type":"string","description":"Currency code for the account details order.","example":"CAD"},"is_account_details_issued":{"type":"boolean","description":"Whether account details have been issued for this order.","example":false},"modification_time":{"type":"string","format":"date-time","description":"When the order was last modified.","example":"2025-08-08T07:49:30Z"},"order_id":{"type":"string","description":"Unique identifier for the account details order.","example":"01989c58-45e4-71dd-9373-7d999e992f99"},"order_status":{"type":"string","description":"Current status of the order.","enum":["PENDING_USER","PENDING_TW","REQUIREMENTS_FULFILLED","DONE"],"example":"REQUIREMENTS_FULFILLED"},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile associated with this order.","example":28835473},"requirements":{"type":"array","description":"List of requirements for this order.","items":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the individual requirement ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"DONE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PENDING\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)"},"children":[]}]}]}],"example":"DONE"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of requirement ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"VERIFICATION\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"VERIFICATION"}}}}}}}}},"components/schemas/v4.0.0-6":{"id":"components/schemas/v4.0.0-6","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"36c3f762-560d-4f07-84f9-5d8a3cacabbb"},"event_type":{"type":"string","description":"Event type identifier","example":"account-details-payment#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Balance ID which is linked to the account detail.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the payment.","example":1},"type":{"type":"string","description":"Type of the resource","example":"balance-account"}}},"account_details_id":{"type":"string","description":"Account detail ID where the pay-in was received.","example":"1"},"target_account_id":{"type":"string","description":"Balance ID which is linked to the account detail.","example":"12345"},"transfer":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the incoming transfer","example":36454},"type":{"type":"string","description":"Type of the transfer","example":"credit"},"amount":{"type":"number","format":"decimal","description":"Transfer amount","example":120},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Sender name","example":"Test Sender"},"account_number":{"type":"string","description":"Sender account number","example":"12345678"},"bank_code":{"type":"string","description":"Sender bank code","example":"TESTBANK"},"address":{"type":"string","description":"Sender address","example":"Test Address"}}},"current_state":{"type":"string","description":"Current state of the payment","enum":["PROCESSING","COMPLETED","CANCELLED","REFUNDED"],"example":"COMPLETED"},"previous_state":{"type":"string","description":"Previous state of the payment","enum":["PROCESSING","COMPLETED","CANCELLED","REFUNDED"],"example":"PROCESSING"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred.","example":"2026-02-24T11:10:13.789Z"}}}}}},"components/schemas/v2.0.0-6":{"id":"components/schemas/v2.0.0-6","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"36c3f762-560d-4f07-84f9-5d8a3cacabbb"},"event_type":{"type":"string","description":"Event type identifier","example":"account-details-payment#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Balance ID which is linked to the account detail.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the payment.","example":1},"type":{"type":"string","description":"Type of the resource","example":"balance-account"}}},"account_details_id":{"type":"string","description":"Account detail ID where the pay-in was received.","example":"1"},"target_account_id":{"type":"string","description":"Balance ID which is linked to the account detail.","example":"12345"},"transfer":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the incoming transfer","example":36454},"type":{"type":"string","description":"Type of the transfer","example":"credit"},"amount":{"type":"number","format":"decimal","description":"Transfer amount","example":120},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Sender name","example":"Test Sender"},"account_number":{"type":"string","description":"Sender account number","example":"12345678"},"bank_code":{"type":"string","description":"Sender bank code","example":"TESTBANK"},"address":{"type":"string","description":"Sender address","example":"Test Address"}}},"current_state":{"type":"string","description":"Current state of the payment","enum":["PROCESSING","COMPLETED","CANCELLED","REFUNDED"],"example":"COMPLETED"},"previous_state":{"type":"string","description":"Previous state of the payment","enum":["PROCESSING","COMPLETED","CANCELLED","REFUNDED"],"example":"PROCESSING"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred.","example":"2026-02-24T11:10:13Z"}}}}}},"components/schemas/v4.0.0-7":{"id":"components/schemas/v4.0.0-7","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"ABCD-1234-ABCD-1234-ABCD"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2022-08-22T07:59:50.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your api_client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":"string","description":"Unique identifier of the card.","example":"ABCD-1234-ABCD-1234-ABCD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"card"}}},"card_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated card status. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is active and can be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is inactive and all transactions will be declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is blocked and cannot be reversed back to any state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is \"blocked\", but temporarily."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is suspended by Wise temporarily due to, for example, fraud reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The cardhoder data (ex: PAN, PIN) have been purged after exceeds the retention period (555 days after the card's expiry date)."},"children":[]}]}]}]}],"example":"FROZEN"},"changed_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the entity that updated the card status. If changed by Wise, the value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise, it is set to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"internal_system"},"occurred_at":{"type":"string","format":"date-time","description":"When the card status change occurred.","example":"2022-08-22T07:49:50.789Z"}}}}}},"components/schemas/v2.0.0-7":{"id":"components/schemas/v2.0.0-7","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"ABCD-1234-ABCD-1234-ABCD"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2022-08-22T07:59:50Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your api_client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":"string","description":"Unique identifier of the card.","example":"ABCD-1234-ABCD-1234-ABCD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"card"}}},"card_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The updated card status. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is active and can be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is inactive and all transactions will be declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BLOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is blocked and cannot be reversed back to any state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FROZEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is \"blocked\", but temporarily."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is suspended by Wise temporarily due to, for example, fraud reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Card is expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The cardholder data (ex: PAN, PIN) have been purged after exceeds the retention period (555 days after the card's expiry date)."},"children":[]}]}]}]}],"example":"FROZEN"},"changed_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier of the entity that updated the card status. If changed by Wise, the value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_system"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise, it is set to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"internal_system"},"occurred_at":{"type":"string","format":"date-time","description":"When the card status change occurred.","example":"2022-08-22T07:49:50Z"}}}}}},"components/schemas/v4.0.0-8":{"id":"components/schemas/v4.0.0-8","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-production-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"type":{"type":"string","description":"Webhook notification of type 'card'.","example":"card"},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":["string","null"],"description":"Unique identifier of the card.","example":"35050a4a-9521-426e-8109-1396e3687a3e"}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current production status. See possible values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection#production-status-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production status flow diagram"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PRODUCED"},"kiosk_id":{"type":["string","null"],"description":"Identifier that specifies which kiosk machine is producing the card.","example":"WIS00001"},"occurred_at":{"type":"string","format":"date-time","description":"Time when the card production request was sent to the kiosk machine.","example":"2024-01-01T12:24:56.789Z"},"error_code":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code returned when card production is not successful. See possible values in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"description":{"type":"string","description":"Detailed description of the error code.","example":"Card produced"}}}}}},"components/schemas/v2.0.0-8":{"id":"components/schemas/v2.0.0-8","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-production-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"type":{"type":"string","description":"Webhook notification of type 'card'.","example":"card"},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":["string","null"],"description":"Unique identifier of the card.","example":"35050a4a-9521-426e-8109-1396e3687a3e"}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current production status. See possible values in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection#production-status-flow"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production status flow diagram"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PRODUCED"},"kiosk_id":{"type":["string","null"],"description":"Identifier that specifies which kiosk machine is producing the card.","example":"WIS00001"},"occurred_at":{"type":"string","format":"date-time","description":"Time when the card production request was sent to the kiosk machine.","example":"2024-01-01T12:24:56Z"},"error_code":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code returned when card production is not successful. See possible values in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production errors"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"description":{"type":"string","description":"Detailed description of the error code.","example":"Card produced"}}}}}},"components/schemas/v4.0.0-9":{"id":"components/schemas/v4.0.0-9","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"ec6d37c2-4611-457a-b210-d1a5f4e354c7"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#3ds-challenge"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-09-05T06:47:15.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]}]}]}],"example":"tw-test-card-issuance"},"card_token":{"type":"string","description":"Card token","example":"3ab81206-d258-4caf-cea5-60067ba82404"},"profile_id":{"type":"integer","format":"int64","description":"Profile ID","example":29751964},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"card"}}},"challenge_expires_after":{"type":"integer","format":"int64","description":"The number of seconds before the challenge expires.","example":300},"occurred_at":{"type":"string","format":"date-time","description":"When the challenge is triggered.","example":"2024-09-05T06:47:15.789Z"},"challenge_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The challenge method chosen by customer (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUSH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"PUSH"},"transaction":{"type":"object","properties":{"reference":{"type":"string","description":"Transaction reference. You should use this field when notifying us of the challenge result.","example":"148990660"},"channel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User agent (usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"browser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"browser"},"merchant":{"type":"object","properties":{"category":{"type":["string","null"],"description":"Merchant category code","example":null},"country":{"type":"string","description":"Merchant country. Follows ISO 3166-1 alpha-2 standard.","example":"AD"},"name":{"type":"string","description":"Merchant name","example":"Cards API BBT"},"url":{"type":["string","null"],"description":"Merchant url","example":"http://intrepid-fav.net"}}},"money_value":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}}}}}}}}},"components/schemas/v2.0.0-9":{"id":"components/schemas/v2.0.0-9","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"ec6d37c2-4611-457a-b210-d1a5f4e354c7"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#3ds-challenge"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-09-05T06:47:15Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]}]}]}],"example":"tw-test-card-issuance"},"card_token":{"type":"string","description":"Card token","example":"3ab81206-d258-4caf-cea5-60067ba82404"},"profile_id":{"type":"integer","format":"int64","description":"Profile ID","example":29751964},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"card"}}},"challenge_expires_after":{"type":"integer","format":"int64","description":"The number of seconds before the challenge expires.","example":300},"occurred_at":{"type":"string","format":"date-time","description":"When the challenge is triggered.","example":"2024-09-05T06:47:15Z"},"challenge_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The challenge method chosen by customer (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUSH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"PUSH"},"transaction":{"type":"object","properties":{"reference":{"type":"string","description":"Transaction reference. You should use this field when notifying us of the challenge result.","example":"148990660"},"channel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User agent (usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"browser"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"browser"},"merchant":{"type":"object","properties":{"category":{"type":["string","null"],"description":"Merchant category code","example":null},"country":{"type":"string","description":"Merchant country. Follows ISO 3166-1 alpha-2 standard.","example":"AD"},"name":{"type":"string","description":"Merchant name","example":"Cards API BBT"},"url":{"type":["string","null"],"description":"Merchant URL","example":"http://intrepid-fav.net"}}},"money_value":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}}}}}}}}},"components/schemas/v4.0.0-10":{"id":"components/schemas/v4.0.0-10","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-order-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"type":{"type":"string","description":"Webhook notification of type 'card'.","example":"card"},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":["string","null"],"description":"Unique identifier of the card.","example":"35050a4a-9521-426e-8109-1396e3687a3e"},"card_program":{"type":"string","description":"The card program associated with this card order. A card program is how Wise refers to all the cards you will be issuing with us, grouped by product type and issuing country.","example":"VISA_DEBIT_CONSUMER_UK_1_PHYSICAL_CARDS_API"}}},"order_id":{"type":"string","description":"Card order ID associated with the status change.","example":"1001L"},"order_status":{"type":"string","description":"Updated card order status","enum":["PLACED","REQUIREMENTS_FULFILLED","CARD_DETAILS_CREATED","PRODUCED","COMPLETED","CANCELLED","RETURNED"],"example":"PRODUCED"},"delivery_vendor":{"type":["string","null"],"description":"Delivery vendor used to dispatch the order (physical card only).","example":"DHL"},"occurred_at":{"type":"string","format":"date-time","description":"When the card order status change occurred.","example":"2023-01-01T12:24:56.789Z"}}}}}},"components/schemas/v2.0.0-10":{"id":"components/schemas/v2.0.0-10","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#card-order-status-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"type":{"type":"string","description":"Webhook notification of type 'card'.","example":"card"},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":["string","null"],"description":"Unique identifier of the card.","example":"35050a4a-9521-426e-8109-1396e3687a3e"},"card_program":{"type":"string","description":"The card program associated with this card order. A card program is how Wise refers to all the cards you will be issuing with us, grouped by product type and issuing country.","example":"VISA_DEBIT_CONSUMER_UK_1_PHYSICAL_CARDS_API"}}},"order_id":{"type":"string","description":"Card order ID associated with the status change.","example":"1001L"},"order_status":{"type":"string","description":"Updated card order status","enum":["PLACED","REQUIREMENTS_FULFILLED","CARD_DETAILS_CREATED","PRODUCED","COMPLETED","CANCELLED","RETURNED"],"example":"PRODUCED"},"delivery_vendor":{"type":["string","null"],"description":"Delivery vendor used to dispatch the order (physical card only).","example":"DHL"},"occurred_at":{"type":"string","format":"date-time","description":"When the card order status change occurred.","example":"2023-01-01T12:24:56Z"}}}}}},"components/schemas/v4.0.0-11":{"id":"components/schemas/v4.0.0-11","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"568da36b-7335-4608-ad1b-e5c2d32273b6"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#transaction-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2022-08-15T11:10:46.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":123456},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":"string","description":"Unique identifier of the card.","example":"136b29e4-7eab-4dac-a017-438d494ef6cb"},"card_last_digits":{"type":"string","description":"Last 4 digits of the card.","example":"1234"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"card"}}},"transaction_id":{"type":"integer","format":"int64","description":"ID of the transaction.","example":12345},"transaction_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving money on the card, excluding Visa OCT or Mastercard MoneySend."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sending money to another card or e-wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cash disbursement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Visa OCT and Mastercard MoneySend."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Online purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Purchase via a POS terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partial or full refund of an existing card transaction."},"children":[]}]}]}]}],"example":"CASH_WITHDRAWAL"},"transaction_step_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction authorization which is usually the first step."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been partially reversed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been fully reversed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAPTURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been captured."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECONCILIATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]}]}],"example":"CAPTURE"},"transaction_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is still in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default fallback status."},"children":[]}]}]}]}],"example":"COMPLETED"},"decline_reason":{"type":["string","null"],"description":"Code of the decline reason if applicable.","example":null},"detailed_decline_reason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the detailed decline reason if applicable. See list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-detailed-decline-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card transaction decline reasons"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"creation_time":{"type":"string","format":"date-time","description":"When the transaction was created.","example":"2022-08-15T11:10:41.456Z"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction state change occurred.","example":"2022-08-15T11:10:41.789Z"},"purge_time":{"type":["string","null"],"format":"date-time","description":"Time at which reserved funds will be released after the authorisation hold expires.","example":"2022-08-22T11:10:41.123Z"},"transaction_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount, excluding all embedded fees such as ATM fees that are not applied by Wise.","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"fees":{"type":"array","description":"Array of fees","items":{"type":"object","properties":{"amount":{"type":"number","format":"decimal","description":"Fee amount","example":1},"currency":{"type":"string","description":"Currency code","example":"EUR"},"fee_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by Wise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_MACHINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by the ATM owner"},"children":[]}]}]}]}],"example":"ATM_WITHDRAWAL"}}}},"transaction_amount_with_fees":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount including all fees.","example":101},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"billing_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Billing amount","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"merchant":{"type":"object","properties":{"name":{"type":"string","description":"Name of the merchant.","example":"Test Payment"},"location":{"type":"object","properties":{"country":{"type":"string","description":"Country where merchant is located.","example":"France"},"city":{"type":"string","description":"City where merchant is located.","example":"Rouen"},"postCode":{"type":["string","null"],"description":"Post code where merchant is located.","example":"00000"},"state":{"type":["string","null"],"description":"State where merchant is located.","example":null}}},"category":{"type":"object","properties":{"code":{"type":"string","description":"Merchant category code","example":"5999"},"description":{"type":"string","description":"Merchant category description","example":"5999 R Miscellaneous and Special"}}}}},"authorisation_method":{"type":"string","description":"Authorisation method","example":"MANUAL_ENTRY"},"approval_code":{"type":"string","description":"Also called authorization code. This can be used to prove ownership of a customer's card/account to a merchant.","example":"913647"},"arn":{"type":["string","null"],"description":"Acquirer reference number","example":"04300014127798385983852"},"pin_validation_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN validation result. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_RECEIVED"},"children":[]}]}]}]}],"example":"ONLINE_PIN_VALIDATED"},"balance_channel_reference_id":{"type":"string","description":"Balance channel reference ID associated with the card transaction.","example":"6e71018d-2f4d-4fc3-6711-f517f4664712"},"debits":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of debits. Note that the debits list is a non-aggregated list of debit movements, meaning that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not unique in the list. For example, a cancelled transaction may have a list of 2 debits where the absolute values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debited_amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"for_amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the same, but one is the negation of the other due to a reservation (first debit) which was then released (second debit with negated amounts). In this case, you can choose to perform the aggregation in your system or display the full list of debits to the end customer."},"children":[]}]}]}],"items":{"type":"object","properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":123},"debited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount taken from the balance.","example":165.96},"currency":{"type":"string","description":"Currency code","example":"AUD"}}},"for_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount converted to","example":101},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"rate":{"type":"number","format":"decimal","description":"Exchange rate","example":0.61223252},"fee":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Conversion fee amount","example":0.99},"currency":{"type":"string","description":"Currency code","example":"AUD"}}},"creation_time":{"type":"string","format":"date-time","description":"Time of balance debit creation.","example":"2022-08-15T11:10:41.456Z"}}}},"credits":{"type":"array","description":"Array of credits","items":{"type":"object","properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":123},"credited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount credited to the balance.","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}}}}},"relay_authorisation_data":{"type":"object","properties":{"response_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relayed authorisation "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/relayed-authorisation#authorisation-response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response code"},"children":[]}]}]}]}],"example":"APPROVED"},"fallback":{"type":"boolean","description":"Whether there was a fallback applied by Wise.","example":true}}}}}}}},"components/schemas/v2.1.0":{"id":"components/schemas/v2.1.0","kind":"json-schema","title":"Schema version 2.1.0","data":{"title":"Schema version 2.1.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.1.0"],"example":"2.1.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"568da36b-7335-4608-ad1b-e5c2d32273b6"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#transaction-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2026-02-02T11:05:20Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card","example":123456},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your api_client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":"string","description":"Unique identifier of the card","example":"136b29e4-7eab-4dac-a017-438d494ef6cb"},"card_last_digits":{"type":"string","description":"Last 4 digits of the card","example":"1234"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"card"}}},"transaction_id":{"type":"integer","format":"int64","description":"ID of the transaction","example":712893},"transaction_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving money on the card, excluding Visa OCT or Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sending money to another card or e-wallet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cash disbursement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Visa OCT and Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Online purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Purchase via a POS Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partial or full refund of an existing card transaction"},"children":[]}]}]}]}],"example":"POS_PURCHASE"},"transaction_step_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction authorization which is usually the first step"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been partially reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been fully reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAPTURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECONCILIATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]}]}],"example":"FULL_REVERSAL"},"transaction_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is still in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default fallback status"},"children":[]}]}]}]}],"example":"CANCELLED"},"decline_reason":{"type":["string","null"],"description":"Code of the decline reason if applicable","example":null},"detailed_decline_reason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the detailed decline reason if applicable. List of available options is available "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-detailed-decline-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"creation_time":{"type":"string","format":"date-time","description":"When the transaction was created","example":"2026-02-02T11:04:41Z"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction state change occurred","example":"2026-02-02T11:05:19Z"},"purge_time":{"type":["string","null"],"format":"date-time","description":"Time at which reserved funds will be released after the authorisation hold expires","example":null},"transaction_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount, excluding all embedded fees such as ATM fees that are not applied by Wise","example":10},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"fees":{"type":"array","description":"Array of fees","items":{"type":"object","properties":{"amount":{"type":"number","format":"decimal","description":"Fee amount","example":1},"currency":{"type":"string","description":"Currency code","example":"EUR"},"fee_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by Wise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_MACHINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by the ATM owner"},"children":[]}]}]}]}],"example":"ATM_WITHDRAWAL"}}}},"transaction_amount_with_fees":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount including all fees","example":10},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"billing_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Billing amount","example":10},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"merchant":{"type":"object","properties":{"name":{"type":"string","description":"Name of the merchant","example":"Acquirer Name"},"location":{"type":"object","properties":{"country":{"type":"string","description":"Country where merchant is located","example":"GB"},"city":{"type":"string","description":"City where merchant is located","example":"CITY NAME"},"postCode":{"type":["string","null"],"description":"Post code where merchant is located","example":"00000"},"state":{"type":["string","null"],"description":"State where merchant is located","example":null}}},"category":{"type":"object","properties":{"code":{"type":"string","description":"Merchant category code","example":"5499"},"description":{"type":"string","description":"Merchant category description","example":"Miscellaneous Food Stores Conven"}}}}},"authorisation_method":{"type":"string","description":"Authorisation method","example":"CONTACTLESS"},"approval_code":{"type":"string","description":"Also called authorization code. This can be used to prove ownership of a customer's card/account to a merchant","example":"723647"},"arn":{"type":["string","null"],"description":"Acquirer reference number","example":null},"pin_validation_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN validation result. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_RECEIVED"},"children":[]}]}]}]}],"example":"NOT_RECEIVED"},"balance_channel_reference_id":{"type":"string","description":"Balance channel reference ID associated with the card transaction","example":"70781abe-9098-42f0-fb1f-6cf428b5068e"},"debits":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of debits. Note that the debits list is a non-aggregated list of debit movements, meaning that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not unique in the list. For example, a cancelled transaction may have a list of 2 debits where the absolute values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debited_amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"for_amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the same, but one is the negation of the other due to a reservation (first debit) which was then released (second debit with negated amounts). In this case, you can choose to perform the aggregation in your system or display the full list of debits to the end customer."},"children":[]}]}]}],"items":{"type":"object","properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":4176832},"debited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount taken from the balance","example":-10},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"for_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount converted to","example":-10},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"rate":{"type":"number","format":"decimal","description":"Exchange rate","example":1},"fee":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Conversion fee amount","example":0},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"creation_time":{"type":"string","format":"date-time","description":"Time of balance debit creation","example":"2026-02-02T11:05:19Z"}}}},"credits":{"type":"array","description":"Array of credits","items":{"type":"object","properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":123},"credited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount credited to the balance","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}}}}},"relay_authorisation_data":{"type":"object","properties":{"response_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relayed authorisation "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/relayed-authorisation#authorisation-response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response code"},"children":[]}]}]}]}],"example":"APPROVED"},"fallback":{"type":"boolean","description":"Whether there was a fallback applied by Wise","example":true}}}}}}}},"components/schemas/v2.0.0-11":{"id":"components/schemas/v2.0.0-11","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"568da36b-7335-4608-ad1b-e5c2d32273b6"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#transaction-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2022-08-15T11:10:46Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card","example":123456},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your api_client_id"},"children":[]}]}]}],"example":"your-bank"},"card_token":{"type":"string","description":"Unique identifier of the card","example":"136b29e4-7eab-4dac-a017-438d494ef6cb"},"card_last_digits":{"type":"string","description":"Last 4 digits of the card","example":"1234"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"card"}}},"transaction_id":{"type":"integer","format":"int64","description":"ID of the transaction","example":12345},"transaction_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receiving money on the card, excluding Visa OCT or Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sending money to another card or e-wallet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_ADVANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cash disbursement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ATM withdrawal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT_TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Visa OCT and Mastercard MoneySend"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ECOM_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Online purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POS_PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Purchase via a POS Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partial or full refund of an existing card transaction"},"children":[]}]}]}]}],"example":"CASH_WITHDRAWAL"},"is_debit":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the transaction type is a debit. This field is deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.transaction_amount.value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine if the transaction is a debit (positive) or a credit into the balance (negative)."},"children":[]}]}]}],"example":true},"transaction_step_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step type of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction authorization which is usually the first step"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTIAL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been partially reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been fully reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAPTURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Transaction has been captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECONCILIATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently unused. Reserved for future use."},"children":[]}]}]}]}],"example":"CAPTURE"},"decline_reason":{"type":["string","null"],"description":"Code of the decline reason if applicable","example":null},"detailed_decline_reason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the detailed decline reason if applicable. List of available options is available "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-transaction#card-transaction-detailed-decline-reasons"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"transaction_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the transaction. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is still in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction is completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction has been cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default fallback status"},"children":[]}]}]}]}],"example":"COMPLETED"},"transaction_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount, excluding all embedded fees such as ATM fees that are not applied by Wise","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"is_amount_confirmed":{"type":"boolean","description":"Whether the transaction amount is confirmed","example":true},"fees":{"type":"array","description":"Array of fees","items":{"type":"object","properties":{"amount":{"type":"number","format":"decimal","description":"Fee amount","example":1},"currency":{"type":"string","description":"Currency code","example":"EUR"},"fee_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee type. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by Wise"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATM_MACHINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fee charged by the ATM owner"},"children":[]}]}]}]}],"example":"ATM_WITHDRAWAL"}}}},"transaction_amount_with_fees":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Transaction amount including fees","example":101},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"billing_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Billing amount","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"authorisation_method":{"type":"string","description":"Authorisation method","example":"CHIP_AND_PIN"},"pin_validation_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN validation result. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_VALIDATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFLINE_PIN_INVALID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_RECEIVED"},"children":[]}]}]}]}],"example":"ONLINE_PIN_VALIDATED"},"approval_code":{"type":"string","description":"Also called authorization code. This can be used to prove ownership of a customer's card/account to a merchant","example":"913647"},"purge_time":{"type":["string","null"],"format":"date-time","description":"Time at which reserved funds will be released after the authorisation hold expires","example":"2022-08-22T11:10:41Z"},"balance_transaction_id":{"type":"integer","format":"int64","description":"Associated balance transaction id if applicable","example":12345},"balance_movements":{"type":"array","description":"Array of balance movements","items":{"type":"object","properties":{"creation_time":{"type":"string","format":"date-time","description":"When the balance movement occurred","example":"2024-12-02T04:17:40Z"},"balance_id":{"type":"string","description":"ID of the balance credited or debited","example":"123"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]}]}]}],"example":"debit"},"amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Credited or debited amount","example":165.96},"currency":{"type":"string","description":"Currency code","example":"AUD"}}}}}},"debits":{"type":"array","description":"Array of debits","items":{"type":"object","properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":123},"debited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount taken from the balance","example":165.96},"currency":{"type":"string","description":"Currency code","example":"AUD"}}},"for_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount converted to","example":101},"currency":{"type":"string","description":"Currency code","example":"EUR"}}},"rate":{"type":"number","format":"decimal","description":"Exchange rate","example":0.61223252},"fee":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Conversion fee amount","example":0.99},"currency":{"type":"string","description":"Currency code","example":"AUD"}}}}}},"credit":{"type":["object","null"],"properties":{"balance_id":{"type":"integer","format":"int64","description":"Balance ID","example":123},"credited_amount":{"type":"object","properties":{"value":{"type":"number","format":"decimal","description":"Amount credited to the balance","example":100},"currency":{"type":"string","description":"Currency code","example":"EUR"}}}}},"merchant":{"type":"object","properties":{"name":{"type":"string","description":"Name of the merchant","example":"Test Payment"},"location":{"type":"object","properties":{"country":{"type":"string","description":"Country where merchant is located","example":"France"},"city":{"type":"string","description":"City where merchant is located","example":"Rouen"},"postCode":{"type":["string","null"],"description":"Post code where merchant is located","example":"00000"},"state":{"type":["string","null"],"description":"State where merchant is located","example":null}}},"category":{"type":"object","properties":{"code":{"type":"string","description":"Merchant category code","example":"6011"},"description":{"type":"string","description":"Merchant category description","example":"6011 Z Member Financial Institution"}}}}},"arn":{"type":["string","null"],"description":"Acquirer reference number","example":"04300014127798385983852"},"creation_time":{"type":"string","format":"date-time","description":"When transaction was created","example":"2022-08-15T11:10:41Z"},"occurred_at":{"type":"string","format":"date-time","description":"When transaction or transaction state change occurred","example":"2022-08-15T11:10:41Z"},"relay_authorisation_data":{"type":"object","properties":{"response_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relayed authorisation "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/relayed-authorisation#authorisation-response"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response code"},"children":[]}]}]}]}],"example":"APPROVED"},"fallback":{"type":"boolean","description":"Whether there was a fallback applied by Wise","example":true}}}}}}}},"components/schemas/v2.0.0-12":{"id":"components/schemas/v2.0.0-12","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"5281e333-a4d9-4960-aec3-553267a9a8aa"},"event_type":{"type":"string","description":"Event type identifier","example":"cards#manual-provisioning-verification"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2026-03-09T05:52:37Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":9953556},"client_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_client_id"},"children":[]}]}]}],"example":"tw-test-card-issuance"},"card_token":{"type":"string","description":"Unique identifier of the card.","example":"72393ec3-0707-4bf1-00b7-744f7a380d2c"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"card"}}},"payment_token_unique_reference":{"type":"string","description":"The payment token unique reference associated to the card.","example":"DNITHE352605523102858206"},"last_four_digits":{"type":"string","description":"The last four digits for the card Primary Account Number (PAN).","example":"8237"},"creation_time":{"type":"string","format":"date-time","description":"The time when the card provisioning request was created.","example":"2026-03-09T05:52:37.274962Z"},"wallet_name":{"type":"string","description":"The wallet provider used to provision the card such as \"Google Pay\" or \"Apple Pay\".","example":"Google Pay"}}}}}},"components/schemas/v4.0.0-12":{"id":"components/schemas/v4.0.0-12","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"hold-limit-breach#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-06-01T08:00:00Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hold-limit-breach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"hold-limit-breach"},"hold_limit_breach_id":{"type":"integer","format":"int64","description":"ID of the hold limit breach.","example":1001},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the breach.","example":12321323}}},"amount":{"type":"number","format":"decimal","description":"Amount that exceeded the hold limit.","example":500.5},"currency":{"type":"string","description":"Currency code (ISO 4217) of the breach amount.","example":"SGD"},"state":{"type":"string","description":"Current state of the breach.","enum":["OPEN","CLOSED"],"example":"CLOSED"},"closing_reason":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the breach was closed. Null if state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["AUTOMATICALLY_RESOLVED","MANUALLY_RESOLVED",null],"example":"MANUALLY_RESOLVED"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the breach was created (ISO 8601).","example":"2024-06-01T08:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the breach was last updated (ISO 8601).","example":"2024-06-01T08:00:00Z"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred (ISO 8601). Use this field to reconcile out-of-order events.","example":"2024-06-01T08:00:00Z"}}}}}},"components/schemas/v4.0.0-13":{"id":"components/schemas/v4.0.0-13","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#cdd-check-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile resource type (always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile.","example":111}}},"current_state":{"type":"string","description":"Current verification state of the profile (see table above).","example":"VERIFIED"},"review_outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the verification review did not pass."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the table above for reason descriptions."},"children":[]}]}]}],"example":"DOCUMENT_OUT_OF_DATE"},"required_evidences":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of required evidences for verification. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of evidences"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find all possible values."},"children":[]}]}]}],"example":["SOURCE_OF_INCOME"]},"occurred_at":{"type":"string","format":"date-time","description":"When the CDD check state change occurred.","example":"2020-01-01T12:34:56.789Z"},"source_of_income":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of income for a personal profile submitted via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/verification/verificationuploadevidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/upload-evidences endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to upload the correct Source of Wealth document."},"children":[]}]}]}],"example":"INVESTMENTS"},"source_of_funding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of funding for a business profile submitted via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/verification/verificationuploadevidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/upload-evidences endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to upload the correct Source of Wealth document."},"children":[]}]}]}],"example":"REVENUE"}}}}}},"components/schemas/v2.0.0-13":{"id":"components/schemas/v2.0.0-13","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#cdd-check-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile resource type (always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile","example":111}}},"current_state":{"type":"string","description":"Current verification state of the profile (see table above).","example":"VERIFIED"},"review_outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the verification review did not pass."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer to the table above for descriptions of these reasons."},"children":[]}]}]}],"example":"DOCUMENT_POOR_QUALITY"},"required_evidences":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of required evidences for verification. Go to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/supported-evidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of evidences"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find all possible values."},"children":[]}]}]}],"example":["SOURCE_OF_INCOME"]},"occurred_at":{"type":"string","format":"date-time","description":"When the CDD check state change occurred","example":"2020-01-01T12:34:56Z"},"source_of_income":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of income for a personal profile submitted via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/verification/verificationuploadevidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/upload-evidences API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to upload the correct Source of Wealth document."},"children":[]}]}]}],"example":"INVESTMENTS"},"source_of_funding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of funding for a business profile submitted via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/verification/verificationuploadevidences"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/upload-evidences API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to upload the correct Source of Wealth document."},"children":[]}]}]}],"example":"REVENUE"}}}}}},"components/schemas/v4.0.0-14":{"id":"components/schemas/v4.0.0-14","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#overdraft-limit-threshold"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile.","example":111}}},"overdraft":{"type":"object","properties":{"used":{"type":"number","format":"decimal","description":"Overdraft limit used","example":12000},"limit":{"type":"number","format":"decimal","description":"Overdraft limit approved","example":20000},"profile_limit_currency":{"type":"string","description":"Currency in which the amounts are expressed in","example":"EUR"},"limit_usage_percentage":{"type":"number","format":"decimal","description":"Percentage of overdraft limit used","example":85}}}}}}}},"components/schemas/v2.0.0-14":{"id":"components/schemas/v2.0.0-14","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#overdraft-limit-threshold"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Profile resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile","example":111}}},"overdraft":{"type":"object","properties":{"used":{"type":"number","format":"decimal","description":"Overdraft limit used","example":12000},"limit":{"type":"number","format":"decimal","description":"Overdraft limit approved","example":20000},"profile_limit_currency":{"type":"string","description":"Currency in which the amounts are expressed in","example":"EUR"},"limit_usage_percentage":{"type":"number","format":"decimal","description":"Percentage of overdraft limit used","example":85}}}}}}}},"components/schemas/v4.0.0-15":{"id":"components/schemas/v4.0.0-15","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the profile.","example":1234},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"profile"}}},"current_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the profile. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITHDRAW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile has 90 calendar days to remove their money from their balance before Wise fully deactivates their account. This can be done through sending from their balance to themselves and others or spending with their card. They cannot receive money to their balances and fund transfers from external bank accounts. They can still order new cards, convert between balances, open and close balances, and download balance statements. After 90 calendar days, the profile will move into a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIEW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile can access and view balances and account activities such as transfer history and balance statements. However, they can no longer perform actions such as moving money with Wise in any way. All transfers sent to the account after it is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIEW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" mode will also bounce back to the sender. Cards will also be suspended."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile's account is deactivated and no actions can be performed on the account. The end-user tokens will be revoked and you will receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for API calls."},"children":[]}]}]}]}],"example":"WITHDRAW_ONLY"},"occurred_at":{"type":"string","format":"date-time","description":"When the profile state change occurred.","example":"2020-01-01T12:34:56.789Z"},"requested_by_customer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the state change was requested by the customer. Not applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false}}}}}},"components/schemas/v2.0.0-15":{"id":"components/schemas/v2.0.0-15","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the profile","example":1234},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"profile"}}},"current_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the profile. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WITHDRAW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile has 90 calendar days to remove their money from their balance before Wise fully deactivates their account. This can be done through sending from their balance to themselves and others or spending with their card. They will not be able to receive money to their balances and fund transfers from external bank accounts. They will still be able to order new cards, convert between balances, open and close balances, and download balance statements. After 90 calendar days, the profile will move into a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIEW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile is able to access and view balances and account activities such as transfer history and balance statements. However, they can no longer perform actions such as moving money with Wise in any way. All transfers sent to the account after it is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIEW_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" mode will also bounce back to the sender. Cards will also be suspended."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The profile's account is deactivated and no actions can be performed on the account. The end-user tokens will be revoked and you will receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response for API calls."},"children":[]}]}]}]}],"example":"WITHDRAW_ONLY"},"occurred_at":{"type":"string","format":"date-time","description":"When the profile state change occurred","example":"2020-01-01T12:34:567890Z"},"requested_by_customer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the state change was requested by the customer. Not applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false}}}}}},"components/schemas/v4.0.0-16":{"id":"components/schemas/v4.0.0-16","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#verification-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile.","example":111}}},"current_state":{"type":"string","description":"Current verification state of the profile.","enum":["verified","not_verified"],"example":"verified"},"occurred_at":{"type":"string","format":"date-time","description":"When the verification state change occurred.","example":"2020-01-01T12:34:56.789Z"}}}}}},"components/schemas/v2.0.0-16":{"id":"components/schemas/v2.0.0-16","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"profiles#verification-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"profile"},"id":{"type":"integer","format":"int64","description":"ID of the profile","example":111}}},"current_state":{"type":"string","description":"Current verification state of the profile","enum":["verified","not_verified"],"example":"verified"},"occurred_at":{"type":"string","format":"date-time","description":"When the verification state change occurred","example":"2020-01-01T12:34:56Z"}}}}}},"components/schemas/v5.0.0-2":{"id":"components/schemas/v5.0.0-2","kind":"json-schema","title":"Schema version 5.0.0","data":{"title":"Schema version 5.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["5.0.0"],"example":"5.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"8df95817-8085-40aa-9bda-e3bf46e7a21a"},"event_type":{"type":"string","description":"Event type identifier","example":"kyc-reviews#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-09-03T16:29:42.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the KYC Review.","example":"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the KYC Review. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC review status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"WAITING_CUSTOMER_INPUT"},"prevState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous status of the KYC review. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC review status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"WAITING_CUSTOMER_INPUT"},"profileId":{"type":"integer","format":"int64","description":"ID of the profile KYC review belongs to.","example":22016766},"requiredBy":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp by which the underlying requirement set needs to be verified to not block the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only relevant if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-09-03T16:22:02.258Z"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp marking the creation of the KYC review.","example":"2024-09-03T16:22:02.258Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp marking the last update of the KYC review.","example":"2024-09-03T16:29:41.148Z"},"triggerReferences":{"type":"array","description":"List of trigger references for this KYC review.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action/process this KYC review is for. Usually a reference to which product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this KYC review is for (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["QUOTE","TRANSFER","PROACTIVE_SEND_MONEY","ADD_MONEY","CARD","BANK_ACCOUNT_DETAILS","INFO_REQUEST"],"example":"QUOTE"},"triggerData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value Object containing metadata of the underlying product object that triggered the KYC review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that refers to their respective IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that contains a list of currencies (ex: USD, SGD, EUR)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the bank details have been created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerReference.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of string"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ID might be null if underlying action is a process like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"example":{"id":"ba83s43a-f623-46f0-956d-196c13e2ab01"}}}}},"requirements":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[Requirement]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, where each inner list represents a combination of possible requirements to be provided. To fulfil the whole KYC review, at least one item from each inner list should be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if the requirements are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[[a, b], [c, d]]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then it should be read as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(a or b) and (c or d)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation for full examples of the schema."},"children":[]}]}]}],"items":{"type":"array","items":{"$ref":"#/components/schemas/kyc-requirement"}}},"requirementChanges":{"type":"array","description":"List of requirement changes that triggered this event.","items":{"type":"object","properties":{"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=key"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requirement that has changed."},"children":[]}]}]}],"example":"ID_DOCUMENT"},"newState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=state"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requirement that has changed."},"children":[]}]}]}],"example":"IN_REVIEW"},"prevState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not provided when requirement is new."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=state"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requirement that has changed. In case only an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=additionalRequirements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional requirement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has changed, this state can be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"NOT_PROVIDED"},"additionalRequirements":{"type":"array","description":"A list of additional requirements that have changed. Not shown if empty.","items":{"type":"object","properties":{"additionalRequirementId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=additionalRequirements/additionalRequirementId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the additional requirement that has changed."},"children":[]}]}]}],"example":"8b789c45-60ae-475d-b667-c8714db9a6a4"},"newState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=additionalRequirements/state"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the additional requirement that has changed."},"children":[]}]}]}],"example":"IN_REVIEW"},"prevState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not provided when additional requirement is new."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The previous "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kyc-requirement#path=additionalRequirements/state"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the additional requirement that has changed."},"children":[]}]}]}],"example":"NOT_PROVIDED"}}}}}}}}}}}}}},"components/schemas/v4.0.0-17":{"id":"components/schemas/v4.0.0-17","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"8df95817-8085-40aa-9bda-e3bf46e7a21a"},"event_type":{"type":"string","description":"Event type identifier","example":"kyc-reviews#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2024-09-03T16:29:42.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the KYC Review.","example":"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the KYC Review. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Review Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"WAITING_CUSTOMER_INPUT"},"profileId":{"type":"integer","format":"int64","description":"ID of the profile KYC Review belongs to.","example":22016766},"requiredBy":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp by which the underlying requirement set needs to be verified to not block the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only relevant if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-09-03T16:22:02.258Z"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp marking the creation of the KYC Review.","example":"2024-09-03T16:22:02.258Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp marking the last update of the KYC Review.","example":"2024-09-03T16:29:41.148Z"},"triggerReferences":{"type":"array","description":"List of trigger references for this KYC Review.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action/process this KYC Review is for. Usually a reference to which product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this KYC Review is for (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["QUOTE","TRANSFER","PROACTIVE_SEND_MONEY","ADD_MONEY","CARD","BANK_ACCOUNT_DETAILS"],"example":"QUOTE"},"triggerData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value Object containing metadata of the underlying product object that triggered the KYC Review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"QUOTE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TRANSFER\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ADD_MONEY\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types, triggerData contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"id\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that refers to their respective IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"BANK_ACCOUNT_DETAILS\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", triggerData has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"currencies\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains a list of currencies (i.e USD, SGD, EUR) that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the bank details have been created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"triggerReference.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of string"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ID might be null if underlying action is a process like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"example":{"id":"ba83s43a-f623-46f0-956d-196c13e2ab01"}}}}},"requirements":{"type":"array","description":"Nested list of KYC requirement objects.","items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The unique identifier of the KYC requirement.","example":"BUSINESS_USE_CASES"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the KYC requirement. Either"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requires information"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requires internal review of the requirement"},"children":[]}]}]}],"example":"NOT_PROVIDED"},"apiCollectionSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A boolean value to indicate if the API collection is available for this evidence. To submit the evidence, refer to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"versions":{"type":"array","description":"Available versions to be submitted for the requirement.","items":{"type":"object","properties":{"version":{"type":"string","description":"Available version identifier to be submitted for the requirement.","example":"V1"},"validUntil":{"type":"string","description":"An optional field that indicates a valid until date."}}}}}}}}}}}}}}},"components/schemas/v2.0.0-17":{"id":"components/schemas/v2.0.0-17","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"8df95817-8085-40aa-9bda-e3bf46e7a21a"},"event_type":{"type":"string","description":"Event type identifier","example":"kyc-reviews#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2024-09-03T16:29:42Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the KYC Review.","example":"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the KYC Review. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/hosted-kyc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Review Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible values."},"children":[]}]}]}],"example":"WAITING_CUSTOMER_INPUT"},"profileId":{"type":"integer","format":"int64","description":"ID of the profile KYC Review belongs to.","example":22016766},"requiredBy":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp by which the underlying requirement set needs to be verified to not block the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only relevant if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSED_WITH_REQUIREMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-09-03T16:22:02.257725"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp marking the creation of the KYC Review.","example":"2024-09-03T16:22:02.257725"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp marking the last update of the KYC Review.","example":"2024-09-03T16:29:41.147522"},"triggerReferences":{"type":"array","description":"List of trigger references for this KYC Review.","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action/process this KYC Review is for. Usually a reference to which product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this KYC Review is for (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["QUOTE","TRANSFER","PROACTIVE_SEND_MONEY","ADD_MONEY","CARD","BANK_ACCOUNT_DETAILS"],"example":"QUOTE"},"triggerData":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value Object containing metadata of the underlying product object that triggered the KYC Review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"QUOTE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TRANSFER\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ADD_MONEY\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types, triggerData contains an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"id\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that refers to their respective IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"BANK_ACCOUNT_DETAILS\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", triggerData has a field called "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"currencies\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains a list of currencies (i.e USD, SGD, EUR) that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the bank details have been created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"triggerReference.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"long"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT_DETAILS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of string"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ID might be null if underlying action is a process like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"example":{"id":"ba83s43a-f623-46f0-956d-196c13e2ab01"}}}}},"requirements":{"type":"array","description":"Nested list of KYC requirement objects.","items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The unique identifier of the KYC requirement.","example":"BUSINESS_USE_CASES"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the KYC requirement. Either"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_PROVIDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requires information"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_REVIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requires internal review of the requirement"},"children":[]}]}]}],"example":"NOT_PROVIDED"},"apiCollectionSupported":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A boolean value to indicate if the API collection is available for this evidence. To submit the evidence, refer to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/kyc-review/kycreviewrequirementsubmit"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC Requirement Submit endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"versions":{"type":"array","description":"Available versions to be submitted for the requirement.","items":{"type":"object","properties":{"version":{"type":"string","description":"Available version identifier to be submitted for the requirement.","example":"V1"},"validUntil":{"type":"string","description":"An optional field that indicates a valid until date."}}}}}}}}}}}}}}},"components/schemas/v4.0.0-18":{"id":"components/schemas/v4.0.0-18","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"users#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the user.","example":1234},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"user"}}},"previous_state":{"type":"string","enum":["ACTIVE","WITHDRAW_ONLY","DEACTIVATED"],"example":"ACTIVE"},"current_state":{"type":"string","description":"The current state of the user.","enum":["ACTIVE","WITHDRAW_ONLY","DEACTIVATED"],"example":"WITHDRAW_ONLY"},"deactivation_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_SUSPENSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is possible to appeal the deactivation by contacting Wise."},"children":[]}]}]}],"enum":["ACCOUNT_SUSPENSION","ACCOUNT_CLOSURE"],"example":"ACCOUNT_SUSPENSION"},"deactivation_reason":{"type":"string","description":"The reason for deactivation.","example":"REQUESTED_BY_CUSTOMER_CS"},"occurred_at":{"type":"string","format":"date-time","description":"When the user state change occurred.","example":"2020-01-01T12:34:56.789Z"}}}}}},"components/schemas/v2.0.0-18":{"id":"components/schemas/v2.0.0-18","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"users#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the user","example":1234},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"user"}}},"previous_state":{"type":"string","enum":["ACTIVE","WITHDRAW_ONLY","DEACTIVATED"],"example":"ACTIVE"},"current_state":{"type":"string","description":"The current state of the user","enum":["ACTIVE","WITHDRAW_ONLY","DEACTIVATED"],"example":"WITHDRAW_ONLY"},"deactivation_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_SUSPENSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it is possible for your customer support teams to appeal the deactivation by reaching out to Wise."},"children":[]}]}]}],"enum":["ACCOUNT_SUSPENSION","ACCOUNT_CLOSURE"],"example":"ACCOUNT_SUSPENSION"},"deactivation_reason":{"type":"string","description":"The reason for deactivation","example":"REQUESTED_BY_CUSTOMER_CS"},"occurred_at":{"type":"string","format":"date-time","description":"When the user state change occurred","example":"2020-01-01T12:34:56Z"}}}}}},"components/schemas/v4.0.0-19":{"id":"components/schemas/v4.0.0-19","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"f2264fe5-a0f5-4dab-a1b4-6faa87761425"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-03-08T14:55:39.456Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance-account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account.","example":2},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account.","example":2}}},"amount":{"type":"number","format":"decimal","description":"Transaction amount","example":70},"balance_id":{"type":"integer","format":"int64","description":"ID of the balance credited or debited.","example":111},"channel_name":{"type":"string","description":"Transfer category","example":"TRANSFER"},"currency":{"type":"string","description":"Currency code","example":"GBP"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction occurred.","example":"2023-03-08T14:55:38.123Z"},"post_transaction_balance_amount":{"type":"number","format":"decimal","description":"Available balance after current transaction.","example":88.93},"step_id":{"type":"integer","format":"int64","description":"Unique identifier for tracking sequence of transaction events.","example":1234567},"transaction_type":{"type":"string","description":"Either credit or debit","example":"credit"},"transfer_reference":{"type":"string","description":"ID of the transfer.","example":"BNK-1234567"}}}}}},"components/schemas/v3.0.0":{"id":"components/schemas/v3.0.0","kind":"json-schema","title":"Schema version 3.0.0","data":{"title":"Schema version 3.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["3.0.0"],"example":"3.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f2264fe5-a0f5-4dab-a1b4-6faa87761425"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2023-03-08T15:26:07Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type (always balance-account)","example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account","example":2},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account","example":2}}},"amount":{"type":"number","format":"decimal","description":"Transaction amount","example":9.6},"balance_id":{"type":"integer","format":"int64","description":"ID of the balance credited or debited","example":111},"channel_name":{"type":"string","description":"Transfer category","example":"TRANSFER"},"currency":{"type":"string","description":"Currency code","example":"GBP"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction occurred","example":"2023-03-08T15:26:07Z"},"post_transaction_balance_amount":{"type":"number","format":"decimal","description":"Available balance after current transaction","example":106.93},"step_id":{"type":"integer","format":"int64","description":"Unique identifier for tracking sequence of transaction events","example":1234567},"transaction_type":{"type":"string","description":"Either credit or debit","example":"debit"},"transfer_reference":{"type":"string","description":"ID of the transfer","example":"47500002"}}}}}},"components/schemas/v2.2.0":{"id":"components/schemas/v2.2.0","kind":"json-schema","title":"Schema version 2.2.0","data":{"title":"Schema version 2.2.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.2.0"],"example":"2.2.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f2264fe5-a0f5-4dab-a1b4-6faa87761425"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2023-03-08T15:26:07Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type (always balance-account)","example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account","example":2},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account","example":2}}},"transaction_type":{"type":"string","description":"Either credit or debit","example":"debit"},"amount":{"type":"number","format":"decimal","description":"Transaction amount","example":9.6},"balance_id":{"type":"integer","format":"int64","description":"ID of the balance credited or debited","example":111},"currency":{"type":"string","description":"Currency code","example":"GBP"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction occurred","example":"2023-03-08T15:26:07Z"},"transfer_reference":{"type":"string","description":"ID of the transfer","example":"47500002"},"channel_name":{"type":"string","description":"Transfer category","example":"TRANSFER"}}}}}},"components/schemas/v2.1.0-2":{"id":"components/schemas/v2.1.0-2","kind":"json-schema","title":"Schema version 2.1.0","data":{"title":"Schema version 2.1.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.1.0"],"example":"2.1.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f2264fe5-a0f5-4dab-a1b4-6faa87761425"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2023-03-08T14:55:39Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":"Resource type (always balance-account)","example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account","example":2},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account","example":2}}},"transaction_type":{"type":"string","description":"Either credit or debit","example":"credit"},"amount":{"type":"number","format":"decimal","description":"Transaction amount","example":70},"currency":{"type":"string","description":"Currency code","example":"GBP"},"occurred_at":{"type":"string","format":"date-time","description":"When the transaction occurred","example":"2023-03-08T14:55:38Z"},"transfer_reference":{"type":"string","description":"ID of the transfer","example":"BNK-1234567"},"channel_name":{"type":"string","description":"Transfer category","example":"TRANSFER"}}}}}},"components/schemas/v4.0.0-20":{"id":"components/schemas/v4.0.0-20","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#account-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance-account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account.","example":123},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account.","example":555},"state":{"type":"string","description":"State of the account.","enum":["ACTIVE","INACTIVE"],"example":"INACTIVE"}}},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred.","example":"2020-01-01T12:34:56.789Z"}}}}}},"components/schemas/v2.0.0-19":{"id":"components/schemas/v2.0.0-19","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"balances#account-state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance-account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"balance-account"},"id":{"type":"integer","format":"int64","description":"ID of the account","example":123},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the account","example":555},"state":{"type":"string","description":"State of the account.","enum":["ACTIVE","INACTIVE"],"example":"INACTIVE"}}},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the event occurred","example":"2020-01-01T12:34:56Z"}}}}}},"components/schemas/v4.0.0-21":{"id":"components/schemas/v4.0.0-21","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"batch-payment-initiations#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2020-01-01T12:34:56.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Payment initiation ID","example":12345},"batch_group_id":{"type":"string","description":"Batch group ID","example":"068e186d-9632-4937-b753-af3e53f4d0b0"},"profile_id":{"type":"integer","format":"int64","description":"The ID of the profile this payment belongs to.","example":2}}},"previous_status":{"type":"string","description":"Previous payment initiation state.","enum":["NEW","PROCESSING","COMPLETED","FAILED","CHARGED_BACK"],"example":"NEW"},"current_status":{"type":"string","description":"Current payment initiation state.","enum":["NEW","PROCESSING","COMPLETED","FAILED","CHARGED_BACK"],"example":"PROCESSING"},"occurred_at":{"type":"string","format":"date-time","description":"When the payment initiation state change occurred.","example":"2021-04-13T19:51:41.423Z"},"return_code":{"type":"string","description":"Return code of the underlying payment system.","example":"200"}}}}}},"components/schemas/v2.0.0-20":{"id":"components/schemas/v2.0.0-20","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"batch-payment-initiations#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2020-01-01T12:34:56Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Payment initiation ID","example":12345},"batchGroupId":{"type":"string","description":"Batch group ID","example":"068e186d-9632-4937-b753-af3e53f4d0b0"},"profileId":{"type":"integer","format":"int64","description":"The ID of the profile this payment belongs to","example":2}}},"previousStatus":{"type":"string","description":"Previous payment initiation state","enum":["NEW","PROCESSING","COMPLETED","FAILED","CHARGED_BACK"],"example":"NEW"},"currentStatus":{"type":"string","description":"Current payment initiation state","enum":["NEW","PROCESSING","COMPLETED","FAILED","CHARGED_BACK"],"example":"PROCESSING"},"occurredAt":{"type":"string","format":"date-time","description":"When the payment initiation state change occurred","example":"2021-04-13T19:51:41.423404Z"},"returnCode":{"type":"string","description":"Return code of the underlying payment system","example":"200"}}}}}},"components/schemas/v5.0.0-3":{"id":"components/schemas/v5.0.0-3","kind":"json-schema","title":"Schema version 5.0.0","data":{"title":"Schema version 5.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["5.0.0"],"example":"5.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"017631af-326c-4a69-93f3-bd1ce987a743"},"event_type":{"type":"string","description":"Event type identifier","example":"partner-support#case-changed"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-06-23T09:45:36.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"ID of the case.","example":123},"profileId":{"type":"integer","format":"int64","description":"ID of the profile that is associated with the case.","example":12345678},"status":{"type":"string","description":"Status of the case.","enum":["CREATING","IN_REVIEW","WAITING_CUSTOMER_INPUT","RESOLVED","FAILED"],"example":"RESOLVED"},"externalId":{"type":"string","description":"External reference ID provided by the partner for the case.","example":"partner_12344567"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the case was created.","example":"2026-04-28T10:00:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the case was last updated. Use this field to reconcile event order.","example":"2026-04-28T14:30:00.000Z"},"type":{"type":"string","description":"Type of the case.","example":"SANCTION"},"subType":{"type":"string","description":"Sub-type of the case providing more specific categorization.","example":"RECIPIENT_LOCATION_HIT"},"reference":{"type":"object","description":"Reference to the resource associated with this case.","properties":{"type":{"type":"string","description":"Type of the referenced resource.","example":"TRANSFER"},"referenceId":{"type":"string","description":"ID of the referenced resource.","example":"123456789"}}},"messages":{"type":"array","description":"List of messages associated with this case.","items":{"$ref":"#/components/schemas/case-message"}}}}}}}}},"components/schemas/v4.0.0-22":{"id":"components/schemas/v4.0.0-22","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","deprecated":true,"properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"017631af-326c-4a69-93f3-bd1ce987a743"},"event_type":{"type":"string","description":"Event type identifier","example":"partner-support#case-changed"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-06-23T09:45:36.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for webhook. Will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner-support-case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"partner-support-case"},"case_id":{"type":"integer","format":"int64","description":"ID of the case.","example":136},"case_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the case. Value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERAL_ENQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". More case types to be added in the future."},"children":[]}]}]}],"example":"GENERAL_ENQUIRY"},"details":{"type":"object","properties":{"transfer_id":{"type":["integer","null"],"format":"int64","description":"ID of the transfer that is associated with the case.","example":12345678},"user_id":{"type":"integer","format":"int64","description":"ID of the user account that is associated with the case.","example":12345678},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that is associated with the case.","example":12345678}}},"status":{"type":"string","description":"Status of the case.","enum":["OPEN","PENDING","SOLVED","CLOSED"],"example":"PENDING"}}},"type":{"type":"string","description":"The type of the webhook being sent.","enum":["STATUS_UPDATED","NEW_COMMENT","NEW_CASE"],"example":"NEW_CASE"},"occurred_at":{"type":"string","format":"date-time","description":"When the case update occurred.","example":"2023-06-23T09:45:34.789Z"}}}}}},"components/schemas/v2.0.0-21":{"id":"components/schemas/v2.0.0-21","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","deprecated":true,"properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"017631af-326c-4a69-93f3-bd1ce987a743"},"event_type":{"type":"string","description":"Event type identifier","example":"partner-support#case-changed"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2023-06-23T09:45:36Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for webhook. Will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner-support-case"},"children":[]}]}]}],"example":"partner-support-case"},"case_id":{"type":"integer","format":"int64","description":"ID of the case","example":136},"case_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the case. Value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERAL_ENQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". More case types will be added in the future."},"children":[]}]}]}],"example":"GENERAL_ENQUIRY"},"details":{"type":"object","properties":{"transfer_id":{"type":["integer","null"],"format":"int64","description":"ID of the transfer that is associated with the case.","example":12345678},"user_id":{"type":"integer","format":"int64","description":"ID of the user account that is associated with the case.","example":12345678},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that is associated with the case.","example":12345678}}},"status":{"type":"string","description":"Status of the case.","enum":["OPEN","PENDING","SOLVED","CLOSED"],"example":"PENDING"}}},"type":{"type":"string","description":"The type of the webhook being sent.","enum":["STATUS_UPDATED","NEW_COMMENT","NEW_CASE"],"example":"NEW_CASE"},"occurred_at":{"type":"string","format":"date-time","description":"When the case update occurred.","example":"2023-06-23T09:45:34Z"}}}}}},"components/schemas/Address-5":{"id":"components/schemas/Address-5","kind":"json-schema","title":"Address-5","data":{"type":"object","description":"Structured address details.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines.","example":["6 Evergreen Ave","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Ave"},"building_number":{"type":"string","description":"Building number.","example":"6"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}}},"components/schemas/BankDetails-2":{"id":"components/schemas/BankDetails-2","kind":"json-schema","title":"BankDetails-2","data":{"type":"object","description":"Bank or financial institution details.","properties":{"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"name":{"type":"string","description":"Bank or financial institution name."},"lei":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI)."},"clearing_system_code":{"type":"string","minLength":1,"maxLength":5,"pattern":"^[A-Z0-9]+$","description":"Code identifying the clearing system in which the institution is registered."},"clearing_system_member_id":{"type":"string","minLength":1,"maxLength":35,"pattern":"^[A-Z0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier within the clearing system specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearing_system_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/Address-5","description":"Bank or financial institution address."}}}},"components/schemas/Party":{"id":"components/schemas/Party","kind":"json-schema","title":"Party","data":{"type":"object","properties":{"name":{"type":"string","description":"Party name.","minLength":1,"maxLength":140},"address":{"$ref":"#/components/schemas/Address-5","description":"Party address."},"account":{"type":"string","description":"An IBAN, BBAN, AccountId, or another account descriptor.","minLength":1,"maxLength":36},"bank_details":{"$ref":"#/components/schemas/BankDetails-2"}}}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Monetary value."},"currency":{"type":"string","description":"3-letter ISO currency code."}}}},"components/schemas/v4.3.0":{"id":"components/schemas/v4.3.0","kind":"json-schema","title":"Schema version 4.3.0","data":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Schema version 4.3.0","type":"object","$defs":{"Address":{"type":"object","description":"Structured address details.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines.","example":["6 Evergreen Ave","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Ave"},"building_number":{"type":"string","description":"Building number.","example":"6"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"BankDetails":{"type":"object","description":"Bank or financial institution details.","properties":{"bic":{"type":"string","description":"Bank Identifier Code (BIC)."},"name":{"type":"string","description":"Bank or financial institution name."},"lei":{"type":"string","pattern":"^[A-Z0-9]{18}[0-9]{2}$","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI)."},"clearing_system_code":{"type":"string","minLength":1,"maxLength":5,"pattern":"^[A-Z0-9]+$","description":"Code identifying the clearing system in which the institution is registered."},"clearing_system_member_id":{"type":"string","minLength":1,"maxLength":35,"pattern":"^[A-Z0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier within the clearing system specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clearing_system_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/Address-5","description":"Bank or financial institution address."}}},"Party":{"type":"object","properties":{"name":{"type":"string","description":"Party name.","minLength":1,"maxLength":140},"address":{"$ref":"#/components/schemas/Address-5","description":"Party address."},"account":{"type":"string","description":"An IBAN, BBAN, AccountId, or another account descriptor.","minLength":1,"maxLength":36},"bank_details":{"$ref":"#/components/schemas/BankDetails-2"}}},"Amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Monetary value."},"currency":{"type":"string","description":"3-letter ISO currency code."}}}},"properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.3.0"],"example":"4.3.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift-in#credit"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-21T12:34:58.123Z"},"data":{"type":"object","required":["action","resource","occurred_at"],"properties":{"action":{"type":"object","required":["type","id","profile_id","account_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of action. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"credit"},"id":{"type":"integer","format":"int64","description":"TransferID of the credit.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ProfileID for the transfer.","example":222},"account_id":{"type":"integer","format":"int64","description":"AccountID for the transfer.","example":333}}},"resource":{"type":"object","required":["id","uetr","exchange_rate","settled_amount","transaction_time","incoming_transfer_type"],"properties":{"id":{"type":"string","description":"ID of the webhook.","example":"55555"},"uetr":{"type":"string","format":"guid","description":"Unique identifier created by the scheme for each payment and passed through the scheme to Wise.","example":"f875814b-7d44-4d1b-a499-123456789abcde"},"reference":{"type":"string","description":"Reference provided by the ultimate sender for the payment.","minLength":0,"maxLength":140,"example":"/RFB/BET072"},"recipient":{"description":"Ultimate recipient.","allOf":[{"$ref":"#/components/schemas/Party"},{"type":"object","properties":{"address":{"properties":{"address_lines":{"example":["6 Evergreen Ave","Brussels"]}}},"bank_details":{"properties":{"bic":{"example":"EXMPBEBB"},"address":{"properties":{"address_lines":{"example":["1 Rue de l'Exemple","Brussels"]}}}}}}}]},"sender":{"description":"Ultimate sender.","allOf":[{"$ref":"#/components/schemas/Party"},{"type":"object","properties":{"address":{"properties":{"address_lines":{"example":["10 Evergreen Street","Brussels"]}}},"bank_details":{"properties":{"bic":{"example":"TESTDEFF"},"address":{"properties":{"address_lines":{"example":["10 Musterstrasse","Frankfurt"]}}}}}}}]},"exchange_rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the originally instructed amount was converted by Wise or any other intermediary agent, this field contains the exchange rate used. If no conversion took place, the exchange rate will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.8},"instructed_amount":{"$ref":"#/components/schemas/Amount","description":"Amount originally instructed by the ultimate sender."},"settled_amount":{"$ref":"#/components/schemas/Amount","description":"Amount settled to the balance account."},"fee":{"type":"object","properties":{"wise":{"type":"array","description":"List of fees applied by Wise (for example, conversion fees). If this list is empty, no fees were applied by Wise.","items":{"allOf":[{"$ref":"#/components/schemas/Amount"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of fee.","example":"conversion"}}}]}},"correspondent":{"type":"array","description":"List of fees declared by correspondents (for example, handling fees). If this list is empty, no fees were declared by correspondents.","items":{"$ref":"#/components/schemas/Amount"}}}},"transaction_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the associated transaction was created. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.456Z"},"previous_instructing_agents":{"type":"array","description":"List of previous instructing agents in the payment chain, ordered from first to last.","items":{"allOf":[{"$ref":"#/components/schemas/BankDetails-2"},{"type":"object","properties":{"bic":{"example":"SAMPUS33"}}}]}},"incoming_transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of incoming SWIFT credit transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies a pacs.008 customer credit transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies a pacs.009 financial institution credit transfer. The recipient or sender may be a financial institution rather than a customer, so account number may not be present."},"children":[]}]}]}],"enum":["CUSTOMER_CREDIT_TRANSFER","FINANCIAL_INSTITUTION_CREDIT_TRANSFER"],"example":"CUSTOMER_CREDIT_TRANSFER"}}},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.789Z"}}}}}},"components/schemas/v4.2.0":{"id":"components/schemas/v4.2.0","kind":"json-schema","title":"Schema version 4.2.0","data":{"title":"Schema version 4.2.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.2.0"],"example":"4.2.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift-in#credit"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-21T12:34:58.123Z"},"data":{"type":"object","required":["action","resource","occurred_at"],"properties":{"action":{"type":"object","required":["type","id","profile_id","account_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of action. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"credit"},"id":{"type":"integer","format":"int64","description":"TransferID of the credit.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ProfileID for the transfer.","example":222},"account_id":{"type":"integer","format":"int64","description":"AccountID for the transfer.","example":333}}},"resource":{"type":"object","required":["id","uetr","exchange_rate","settled_amount","transaction_time","incoming_transfer_type"],"properties":{"id":{"type":"string","description":"ID of the webhook.","example":"55555"},"uetr":{"type":"string","format":"guid","description":"Unique identifier created by the scheme for each payment and passed through the scheme to Wise.","example":"f875814b-7d44-4d1b-a499-123456789abcde"},"reference":{"type":"string","description":"Reference provided by the ultimate sender for the payment.","minLength":0,"maxLength":140,"example":"/RFB/BET072"},"recipient":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate recipient.","minLength":1,"maxLength":140,"example":"JOHN SMITH"},"address":{"type":"object","description":"Structured address of the ultimate recipient.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["6 Evergreen Ave","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Ave"},"building_number":{"type":"string","description":"Building number.","example":"6"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"BE1234567891234"},"bank_details":{"type":"object","description":"Recipient bank details.","properties":{"bic":{"type":"string","description":"Recipient bank BIC.","example":"EXMPBEBB"},"name":{"type":"string","description":"Recipient bank name.","example":"EXAMPLE BANK BELGIUM"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["1 Rue de l'Exemple","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Rue de l'Exemple"},"building_number":{"type":"string","description":"Building number.","example":"1"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}}}}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate sender.","minLength":1,"maxLength":140,"example":"GEORGE SMITH"},"address":{"type":"object","description":"Structured address of the ultimate sender.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["10 Evergreen Street","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Street"},"building_number":{"type":"string","description":"Building number.","example":"10"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"EE947700771111111111"},"bank_details":{"type":"object","description":"Sender bank details.","properties":{"bic":{"type":"string","description":"Sender bank BIC.","example":"TESTDEFF"},"name":{"type":"string","description":"Sender bank name.","example":"TEST BANK AG"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["10 Musterstrasse","Frankfurt"]},"street_name":{"type":"string","description":"Street name.","example":"Musterstrasse"},"building_number":{"type":"string","description":"Building number.","example":"99"},"town_name":{"type":"string","description":"Town (city) name.","example":"FRANKFURT"},"postal_code":{"type":"string","description":"Postal code.","example":"60311"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"DE"}}}}}}},"exchange_rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the originally instructed amount was converted by Wise or any other intermediary agent, this field contains the exchange rate used. If no conversion took place, the exchange rate will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.8},"instructed_amount":{"type":"object","description":"Amount originally instructed by the ultimate sender.","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount originally instructed by the ultimate sender.","example":1000},"currency":{"type":"string","description":"Currency of the amount originally instructed by the ultimate sender. 3-letter ISO currency code.","example":"USD"}}},"settled_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount settled to the balance account.","example":786.54},"currency":{"type":"string","description":"Currency of the amount settled to the balance account. 3-letter ISO currency code.","example":"GBP"}}},"fee":{"type":"object","properties":{"wise":{"type":"array","description":"List of fees applied by Wise (for example, conversion fees). If this list is empty, no fees were applied by Wise.","items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"type":"string","description":"Type of fee.","example":"conversion"},"value":{"type":"number","format":"double","description":"Value of fee.","example":2.76},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"GBP"}}}},"correspondent":{"type":"array","description":"List of fees declared by correspondents (for example, handling fees). If this list is empty, no fees were declared by correspondents.","items":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of fee.","example":4.5},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"USD"}}}}}},"transaction_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the associated transaction was created. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.456Z"},"previous_instructing_agents":{"type":"array","description":"List of previous instructing agents in the payment chain, ordered from first to last.","items":{"type":"object","properties":{"bic":{"type":"string","description":"Previous instructing agent BIC.","example":"SAMPUS33"},"name":{"type":"string","description":"Previous instructing agent bank name.","example":"SAMPLE BANK USA"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous instructing agent bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["100 Fictional Avenue","NEW YORK"]},"street_name":{"type":"string","description":"Street name.","example":"Fictional Avenue"},"building_number":{"type":"string","description":"Building number.","example":"100"},"town_name":{"type":"string","description":"Town (city) name.","example":"NEW YORK"},"postal_code":{"type":"string","description":"Postal code.","example":"10001"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region.","example":"NY"},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"US"}}}}}},"incoming_transfer_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of incoming SWIFT credit transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies a pacs.008 customer credit transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINANCIAL_INSTITUTION_CREDIT_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies a pacs.009 financial institution credit transfer. The recipient or sender may be a financial institution rather than a customer, so account number may not be present."},"children":[]}]}]}],"enum":["CUSTOMER_CREDIT_TRANSFER","FINANCIAL_INSTITUTION_CREDIT_TRANSFER"],"example":"CUSTOMER_CREDIT_TRANSFER"}}},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.789Z"}}}}}},"components/schemas/v4.1.0":{"id":"components/schemas/v4.1.0","kind":"json-schema","title":"Schema version 4.1.0","data":{"title":"Schema version 4.1.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.1.0"],"example":"4.1.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift-in#credit"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-21T12:34:58.123Z"},"data":{"type":"object","required":["action","resource","occurred_at"],"properties":{"action":{"type":"object","required":["type","id","profile_id","account_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of action. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"credit"},"id":{"type":"integer","format":"int64","description":"TransferID of the credit.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ProfileID for the transfer.","example":222},"account_id":{"type":"integer","format":"int64","description":"AccountID for the transfer.","example":333}}},"resource":{"type":"object","required":["id","uetr","exchange_rate","settled_amount","transaction_time"],"properties":{"id":{"type":"string","description":"ID of the webhook.","example":"55555"},"uetr":{"type":"string","format":"guid","description":"Unique identifier created by the scheme for each payment and passed through the scheme to Wise.","example":"f875814b-7d44-4d1b-a499-123456789abcde"},"reference":{"type":"string","description":"Reference provided by the ultimate sender for the payment.","minLength":0,"maxLength":140,"example":"/RFB/BET072"},"recipient":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate recipient.","minLength":1,"maxLength":140,"example":"JOHN SMITH"},"address":{"type":"object","description":"Structured address of the ultimate recipient.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["6 Evergreen Ave","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Ave"},"building_number":{"type":"string","description":"Building number.","example":"6"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"BE1234567891234"},"bank_details":{"type":"object","description":"Recipient bank details.","properties":{"bic":{"type":"string","description":"Recipient bank BIC.","example":"EXMPBEBB"},"name":{"type":"string","description":"Recipient bank name.","example":"EXAMPLE BANK BELGIUM"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["1 Rue de l'Exemple","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Rue de l'Exemple"},"building_number":{"type":"string","description":"Building number.","example":"1"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}}}}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate sender.","minLength":1,"maxLength":140,"example":"GEORGE SMITH"},"address":{"type":"object","description":"Structured address of the ultimate sender.","properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["10 Evergreen Street","Brussels"]},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Street"},"building_number":{"type":"string","description":"Building number.","example":"10"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"EE947700771111111111"},"bank_details":{"type":"object","description":"Sender bank details.","properties":{"bic":{"type":"string","description":"Sender bank BIC.","example":"TESTDEFF"},"name":{"type":"string","description":"Sender bank name.","example":"TEST BANK AG"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["10 Musterstrasse","Frankfurt"]},"street_name":{"type":"string","description":"Street name.","example":"Musterstrasse"},"building_number":{"type":"string","description":"Building number.","example":"99"},"town_name":{"type":"string","description":"Town (city) name.","example":"FRANKFURT"},"postal_code":{"type":"string","description":"Postal code.","example":"60311"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"DE"}}}}}}},"exchange_rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the originally instructed amount was converted by Wise or any other intermediary agent, this field contains the exchange rate used. If no conversion took place, the exchange rate will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.8},"instructed_amount":{"type":"object","description":"Amount originally instructed by the ultimate sender.","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount originally instructed by the ultimate sender.","example":1000},"currency":{"type":"string","description":"Currency of the amount originally instructed by the ultimate sender. 3-letter ISO currency code.","example":"USD"}}},"settled_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount settled to the balance account.","example":786.54},"currency":{"type":"string","description":"Currency of the amount settled to the balance account. 3-letter ISO currency code.","example":"GBP"}}},"fee":{"type":"object","properties":{"wise":{"type":"array","description":"List of fees applied by Wise (for example, conversion fees). If this list is empty, no fees were applied by Wise.","items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"type":"string","description":"Type of fee.","example":"conversion"},"value":{"type":"number","format":"double","description":"Value of fee.","example":2.76},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"GBP"}}}},"correspondent":{"type":"array","description":"List of fees declared by correspondents (for example, handling fees). If this list is empty, no fees were declared by correspondents.","items":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of fee.","example":4.5},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"USD"}}}}}},"transaction_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the associated transaction was created. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.456Z"},"previous_instructing_agents":{"type":"array","description":"List of previous instructing agents in the payment chain, ordered from first to last.","items":{"type":"object","properties":{"bic":{"type":"string","description":"Previous instructing agent BIC.","example":"SAMPUS33"},"name":{"type":"string","description":"Previous instructing agent bank name.","example":"SAMPLE BANK USA"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous instructing agent bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address lines concatenated into a single line. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address_lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"address_lines":{"type":"array","items":{"type":"string"},"description":"Unstructured address lines","example":["100 Fictional Avenue","NEW YORK"]},"street_name":{"type":"string","description":"Street name.","example":"Fictional Avenue"},"building_number":{"type":"string","description":"Building number.","example":"100"},"town_name":{"type":"string","description":"Town (city) name.","example":"NEW YORK"},"postal_code":{"type":"string","description":"Postal code.","example":"10001"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region.","example":"NY"},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"US"}}}}}}}},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.789Z"}}}}}},"components/schemas/v4.0.0-23":{"id":"components/schemas/v4.0.0-23","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift-in#credit"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2023-08-21T12:34:58.123Z"},"data":{"type":"object","required":["action","resource","occurred_at"],"properties":{"action":{"type":"object","required":["type","id","profile_id","account_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of action. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"credit"},"id":{"type":"integer","format":"int64","description":"TransferID of the credit.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ProfileID for the transfer.","example":222},"account_id":{"type":"integer","format":"int64","description":"AccountID for the transfer.","example":333}}},"resource":{"type":"object","required":["id","uetr","exchange_rate","settled_amount","transaction_time"],"properties":{"id":{"type":"string","description":"ID of the webhook.","example":"55555"},"uetr":{"type":"string","format":"guid","description":"Unique identifier created by the scheme for each payment and passed through the scheme to Wise.","example":"f875814b-7d44-4d1b-a499-123456789abcde"},"reference":{"type":"string","description":"Reference provided by the ultimate sender for the payment.","minLength":0,"maxLength":140,"example":"/RFB/BET072"},"recipient":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate recipient.","minLength":1,"maxLength":140,"example":"JOHN SMITH"},"address":{"type":"object","description":"Structured address of the ultimate recipient.","properties":{"first_line":{"type":"string","description":"Address first line."},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Ave"},"building_number":{"type":"string","description":"Building number.","example":"6"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"BE1234567891234"},"bank_details":{"type":"object","description":"Recipient bank details.","properties":{"bic":{"type":"string","description":"Recipient bank BIC.","example":"EXMPBEBB"},"name":{"type":"string","description":"Recipient bank name.","example":"EXAMPLE BANK BELGIUM"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":"Address first line."},"street_name":{"type":"string","description":"Street name.","example":"Rue de l'Exemple"},"building_number":{"type":"string","description":"Building number.","example":"1"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}}}}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate sender.","minLength":1,"maxLength":140,"example":"GEORGE SMITH"},"address":{"type":"object","description":"Structured address of the ultimate sender.","properties":{"first_line":{"type":"string","description":"Address first line."},"street_name":{"type":"string","description":"Street name.","example":"Evergreen Street"},"building_number":{"type":"string","description":"Building number.","example":"10"},"town_name":{"type":"string","description":"Town (city) name.","example":"BRUSSELS"},"postal_code":{"type":"string","description":"Postal code.","example":"1000"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"BE"}}},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"EE947700771111111111"},"bank_details":{"type":"object","description":"Sender bank details.","properties":{"bic":{"type":"string","description":"Sender bank BIC.","example":"TESTDEFF"},"name":{"type":"string","description":"Sender bank name.","example":"TEST BANK AG"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":"Address first line."},"street_name":{"type":"string","description":"Street name.","example":"Musterstrasse"},"building_number":{"type":"string","description":"Building number.","example":"99"},"town_name":{"type":"string","description":"Town (city) name.","example":"FRANKFURT"},"postal_code":{"type":"string","description":"Postal code.","example":"60311"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region."},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"DE"}}}}}}},"exchange_rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the originally instructed amount was converted by Wise or any other intermediary agent, this field contains the exchange rate used. If no conversion took place, the exchange rate will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.8},"instructed_amount":{"type":"object","description":"Amount originally instructed by the ultimate sender.","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount originally instructed by the ultimate sender.","example":1000},"currency":{"type":"string","description":"Currency of the amount originally instructed by the ultimate sender. 3-letter ISO currency code.","example":"USD"}}},"settled_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount settled to the balance account.","example":786.54},"currency":{"type":"string","description":"Currency of the amount settled to the balance account. 3-letter ISO currency code.","example":"GBP"}}},"fee":{"type":"object","properties":{"wise":{"type":"array","description":"List of fees applied by Wise (for example, conversion fees). If this list is empty, no fees were applied by Wise.","items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"type":"string","description":"Type of fee.","example":"conversion"},"value":{"type":"number","format":"double","description":"Value of fee.","example":2.76},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"GBP"}}}},"correspondent":{"type":"array","description":"List of fees declared by correspondents (for example, handling fees). If this list is empty, no fees were declared by correspondents.","items":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of fee.","example":4.5},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"USD"}}}}}},"transaction_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the associated transaction was created. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.456Z"},"previous_instructing_agents":{"type":"array","description":"List of previous instructing agents in the payment chain, ordered from first to last.","items":{"type":"object","properties":{"bic":{"type":"string","description":"Previous instructing agent BIC.","example":"SAMPUS33"},"name":{"type":"string","description":"Previous instructing agent bank name.","example":"SAMPLE BANK USA"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous instructing agent bank address (same structure as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recipient.address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"first_line":{"type":"string","description":"Address first line."},"street_name":{"type":"string","description":"Street name.","example":"Fictional Avenue"},"building_number":{"type":"string","description":"Building number.","example":"100"},"town_name":{"type":"string","description":"Town (city) name.","example":"NEW YORK"},"postal_code":{"type":"string","description":"Postal code.","example":"10001"},"country_sub_division":{"type":"string","description":"Country subdivision such as a state, province, or region.","example":"NY"},"country_code":{"type":"string","description":"Country code. 2-letter ISO country code.","example":"US"}}}}}}}},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.789Z"}}}}}},"components/schemas/v3.0.0-2":{"id":"components/schemas/v3.0.0-2","kind":"json-schema","title":"Schema version 3.0.0","data":{"title":"Schema version 3.0.0","type":"object","deprecated":true,"properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["3.0.0"],"example":"3.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift-in#credit"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2023-08-21T12:34:58Z"},"data":{"type":"object","required":["action","resource","occurred_at"],"properties":{"action":{"type":"object","required":["type","id","profile_id","account_id"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of action. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"credit"},"id":{"type":"integer","format":"int64","description":"TransferID of the credit.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"ProfileID for the transfer.","example":222},"account_id":{"type":"integer","format":"int64","description":"AccountID for the transfer.","example":333}}},"resource":{"type":"object","required":["id","uetr","exchange_rate","settled_amount","transaction_time"],"properties":{"id":{"type":"string","description":"ID of the webhook.","example":"55555"},"uetr":{"type":"string","format":"guid","description":"Unique identifier created by the scheme for each payment and passed through the scheme to Wise.","example":"f875814b-7d44-4d1b-a499-123456789abcde"},"reference":{"type":"string","description":"Reference provided by the ultimate sender for the payment.","minLength":0,"maxLength":140,"example":"/RFB/BET072"},"recipient":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate recipient.","minLength":1,"maxLength":140,"example":"JOHN SMITH"},"address":{"type":"string","description":"Address of the ultimate recipient.","minLength":1,"maxLength":140,"example":"EVERGREEN AVE, 6, BRUSSELS, BE"},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"BE1234567891234"},"bank_details":{"type":"object","description":"Recipient bank details.","properties":{"bic":{"type":"string","description":"Recipient bank BIC.","example":"EXMPBEBB"},"name":{"type":"string","description":"Recipient bank name.","example":"EXAMPLE BANK BELGIUM"},"address":{"type":"string","description":"Recipient bank address.","example":"Rue de l'Exemple, BRUSSELS"}}}}},"sender":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate sender.","minLength":1,"maxLength":140,"example":"GEORGE SMITH"},"address":{"type":"string","description":"Address of the ultimate sender.","minLength":1,"maxLength":140,"example":"EVERGREEN STREET, 10, BRUSSELS, BE"},"account":{"type":"string","description":"This can be either an IBAN, BBAN, AccountId or a Descriptor (another kind of identifier).","minLength":1,"maxLength":36,"example":"EE947700771111111111"},"bank_details":{"type":"object","description":"Sender bank details.","properties":{"bic":{"type":"string","description":"Sender bank BIC.","example":"TESTDEFF"},"name":{"type":"string","description":"Sender bank name.","example":"TEST BANK AG"},"address":{"type":"string","description":"Sender bank address.","example":"Musterstrasse, FRANKFURT"}}},"bank_code":{"type":"object","description":"Ultimate sender's bank code.","properties":{"value":{"type":"string","description":"Value of the ultimate sender's bank code. This can be either a BIC code, bank institution name, clearing system member code or LEI.","example":"ABNABE2AIDJ"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the ultimate sender's bank code. This can be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_CODE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"BIC"}}}}},"exchange_rate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the originally instructed amount was converted by Wise or any other intermediary agent, this field contains the exchange rate used. If no conversion took place, the exchange rate will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.8},"instructed_amount":{"type":"object","description":"Amount originally instructed by the ultimate sender.","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount originally instructed by the ultimate sender.","example":1000},"currency":{"type":"string","description":"Currency of the amount originally instructed by the ultimate sender. 3-letter ISO currency code.","example":"USD"}}},"settled_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of the amount settled to the balance account.","example":786.54},"currency":{"type":"string","description":"Currency of the amount settled to the balance account. 3-letter ISO currency code.","example":"GBP"}}},"fee":{"type":"object","properties":{"wise":{"type":"array","description":"List of fees applied by Wise (e.g., conversion fee). If this list is empty, no fees were applied by Wise.","items":{"type":"object","required":["type","value","currency"],"properties":{"type":{"type":"string","description":"Type of fee.","example":"conversion"},"value":{"type":"number","format":"double","description":"Value of fee.","example":2.76},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"GBP"}}}},"correspondent":{"type":"array","description":"List of fees declared by correspondents (e.g., handling fee). If this list is empty, no fees were declared by correspondents.","items":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"number","format":"double","description":"Value of fee.","example":4.5},"currency":{"type":"string","description":"Currency of fee. 3-letter ISO currency code.","example":"USD"}}}}}},"transaction_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the associated transaction was created. Time in UTC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56Z"}}},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56Z"}}}}}},"components/schemas/v4.0.0-24":{"id":"components/schemas/v4.0.0-24","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"swift#message-received"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2025-10-21T12:34:58.123Z"},"data":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The transfer ID of the incoming payment.","example":12345},"profile_id":{"type":"integer","format":"int64","description":"The profile ID of the incoming payment.","example":222},"account_id":{"type":"integer","format":"int64","description":"The balance account ID where funds will be deposited.","example":333}}},"occurred_at":{"type":"string","format":"date-time","description":"Date and time at which the SWIFT message was processed by Wise. Time in UTC.","example":"2025-10-21T12:34:56.789Z"},"resource":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the SWIFT message.","example":"a1b2c3d4e5f6"},"message_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of SWIFT message contained in the content field (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pacs.008.001.08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Extensible for future message types."},"children":[]}]}]}],"example":"pacs.008.001.08"},"content":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The raw SWIFT message data, encoded as specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PD94bWwgdmVyc2lvbj0iMS4wIj8+..."},"content_encoding":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The encoding applied to the content field. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base64"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"base64"}}}}}}}},"components/schemas/v4.0.0-25":{"id":"components/schemas/v4.0.0-25","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"7bb32a11-74ad-43b6-9505-3f5facbc87ed"},"event_type":{"type":"string","description":"Event type identifier","example":"transaction-disputes#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-04-18T06:36:17.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the dispute.","example":"39f893e3-4b0c-4850-9c5c-8cb8f4798a43"},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card.","example":16605997},"transaction_id":{"type":"integer","format":"int64","description":"ID of the card transaction.","example":4337},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction-dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"transaction-dispute"}}},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute reason. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes/disputereasonsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute reason"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible values."},"children":[]}]}]}],"example":"WRONG_AMOUNT"},"status":{"type":"string","description":"Dispute overall status","enum":["ACTIVE","CLOSED"],"example":"CLOSED"},"sub_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute detailed status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes#dispute-sub-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute sub-status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible values."},"children":[]}]}]}],"example":"WITHDRAWN"},"status_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Withdrawn"},"created_at":{"type":"string","format":"date-time","description":"Time when the dispute was created.","example":"2024-04-18T06:17:12.456Z"},"created_by":{"type":"string","description":"Creator of the dispute. Currently set to the user id.","example":"6097861"},"can_withdraw":{"type":"boolean","description":"Whether the dispute can be withdrawn.","example":false},"occurred_at":{"type":"string","format":"date-time","description":"When the dispute updates occurred.","example":"2024-04-18T06:36:15.789Z"}}}}}},"components/schemas/v2.0.0-22":{"id":"components/schemas/v2.0.0-22","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"7bb32a11-74ad-43b6-9505-3f5facbc87ed"},"event_type":{"type":"string","description":"Event type identifier","example":"transaction-disputes#update"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2024-04-18T06:36:17Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the dispute","example":"39f893e3-4b0c-4850-9c5c-8cb8f4798a43"},"profile_id":{"type":"integer","format":"int64","description":"ID of the profile that owns the card","example":16605997},"transaction_id":{"type":"integer","format":"int64","description":"ID of the card transaction","example":4337},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource type (always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction-dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"transaction-dispute"}}},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute reason, you can find all the possible values "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes/disputereasonsget"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]}]}]}],"example":"WRONG_AMOUNT"},"status":{"type":"string","description":"Dispute overall status","enum":["ACTIVE","CLOSED"],"example":"CLOSED"},"sub_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute detailed status, you can find all the possible values "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes#dispute-sub-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]}]}]}],"example":"WITHDRAWN"},"status_message":{"type":"string","description":"Explanation for subStatus","example":"Withdrawn"},"created_at":{"type":"string","format":"date-time","description":"Time when the dispute was created","example":"2024-04-18T06:17:12Z"},"created_by":{"type":"string","description":"Creator of the dispute, it is currently set to the user id","example":"6097861"},"can_withdraw":{"type":"boolean","description":"Whether the dispute can be withdrawn","example":false},"occurred_at":{"type":"string","format":"date-time","description":"When the dispute updates occurred","example":"2024-04-18T06:36:15Z"}}}}}},"components/schemas/v4.0.0-26":{"id":"components/schemas/v4.0.0-26","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"bulk-settlement#payment-received"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2024-04-18T06:36:17.123Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"settlement_reference":{"type":"string","description":"Reference on settlement journal","example":"TPFB1111111"},"source_currency":{"type":"string","description":"Settlement currency","example":"GBP"},"source_amount":{"type":"number","format":"decimal","description":"The amount Wise paid out on behalf of partner.","example":-100.1},"target_amount":{"type":"number","format":"decimal","description":"Total settlement fund received for this settlement journal.","example":100.1},"amount_matched":{"type":"boolean","description":"Whether amount received matches what is expected.","example":true}}},"occurred_at":{"type":"string","format":"date-time","description":"When the settlement fund was received.","example":"2024-04-18T06:36:15.789Z"}}}}}},"components/schemas/v3.0.0-3":{"id":"components/schemas/v3.0.0-3","kind":"json-schema","title":"Schema version 3.0.0","data":{"title":"Schema version 3.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["3.0.0"],"example":"3.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"bulk-settlement#payment-received"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2024-04-18T06:36:17Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"settlement_reference":{"type":"string","description":"Reference on settlement journal","example":"TPFB1111111"},"source_currency":{"type":"string","description":"Settlement currency","example":"GBP"},"source_amount":{"type":"number","format":"decimal","description":"The amount Wise paid out on behalf of partner","example":-100.1},"target_amount":{"type":"number","format":"decimal","description":"Total settlement fund received for this settlement journal","example":100.1},"amount_matched":{"type":"boolean","description":"Whether amount received matches what is expected","example":true}}},"occurred_at":{"type":"string","format":"date-time","description":"When the settlement fund was received","example":"2024-04-18T06:36:15Z"}}}}}},"components/schemas/v2.0.0-23":{"id":"components/schemas/v2.0.0-23","kind":"json-schema","title":"Schema version 2.0.0","data":{"title":"Schema version 2.0.0","deprecated":true,"type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["2.0.0"],"example":"2.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event","example":"f5b51f77-e14a-433b-9f7c-fc2834ffcff5"},"event_type":{"type":"string","description":"Event type identifier","example":"bulk-settlement#payment-received"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent","example":"2024-04-18T06:36:17Z"},"data":{"type":"object","properties":{"resource":{"type":"object","properties":{"settlement_reference":{"type":"string","description":"Reference on settlement journal","example":"TPFB1111111"},"source_currency":{"type":"string","description":"Settlement currency","example":"GBP"},"received_amount":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please be aware that this field is unreliable. Always refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the total amount paid, and check the difference between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see how much more needs to be paid."},"children":[]}]}]}],"example":10.1},"source_amount":{"type":"number","format":"decimal","description":"The amount Wise paid out on behalf of partner","example":-100.1},"target_amount":{"type":"number","format":"decimal","description":"Total settlement fund received for this settlement journal","example":100.1},"amount_matched":{"type":"boolean","description":"Whether amount received matches what is expected","example":true}}},"occurred_at":{"type":"string","format":"date-time","description":"When the settlement fund was received","example":"2024-04-18T06:36:15Z"}}}}}},"components/schemas/v4.0.0-27":{"id":"components/schemas/v4.0.0-27","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"01234567-89ab-cdef-0123-456789abcdef"},"event_type":{"type":"string","description":"Event type identifier","example":"incoming-transfer#credited"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2025-10-21T12:34:58.123Z"},"data":{"type":"object","required":["incoming_transfer_id","occurred_at"],"properties":{"incoming_transfer_id":{"type":"string","format":"uuid","description":"Incoming Transfer ID","example":"01234567-89ab-cdef-0123-456789abcdef"},"occurred_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the amount was credited to the balance account. Time in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Z"},"children":[]}]}]}],"example":"2023-08-21T12:34:56.789Z"}}}}}},"components/schemas/v4.0.0-28":{"id":"components/schemas/v4.0.0-28","kind":"json-schema","title":"Schema version 4.0.0","data":{"title":"Schema version 4.0.0","type":"object","required":["schema_version","subscription_id","event_type","sent_at","data"],"properties":{"schema_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the event schema. Determined by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/webhook"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook subscription"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["4.0.0"],"example":"4.0.0"},"subscription_id":{"type":"string","format":"uuid","description":"ID of the webhook subscription that triggered this event.","example":"ced03af9-be76-46ac-ada8-7fe935792290"},"event_type":{"type":"string","description":"Event type identifier.","enum":["recipients#state-change"],"example":"recipients#state-change"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the event was sent.","example":"2026-06-15T13:18:20.265Z"},"data":{"type":"object","required":["resource"],"properties":{"resource":{"type":"object","required":["id","occurred_at","data"],"properties":{"id":{"type":"string","description":"Resource identifier for the changed recipient.","example":"700525176"},"occurred_at":{"type":"string","format":"date-time","description":"Timestamp when the recipient state change occurred.","example":"2026-06-15T13:18:20.265Z"},"data":{"type":"object","required":["recipientId","profileId","currency","state","clientId"],"properties":{"recipientId":{"type":"integer","format":"int64","description":"Recipient account ID.","example":700525176},"profileId":{"type":"integer","format":"int64","description":"Profile ID that owns the recipient.","example":14966143},"currency":{"type":"string","description":"Recipient account currency.","example":"EUR"},"state":{"type":"string","description":"Recipient state that triggered the event.","enum":["CREATE","UPDATE","DEACTIVATE","OBFUSCATE","DELETE"],"example":"CREATE"},"clientId":{"type":"string","description":"Partner client ID associated with the recipient.","example":"hosted-kyc-test-client"}}}}}}}}}},"schema_621":{"kind":"json-schema","data":{"type":"string","format":"uuid","maxLength":36},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"discriminator":{"propertyName":"grant_type","mapping":{"client_credentials":"#/components/schemas/client-credentials-grant","registration_code":"#/components/schemas/registration-code-grant","authorization_code":"#/components/schemas/authorization-code-grant","refresh_token":"#/components/schemas/refresh-token-grant"}},"oneOf":[{"$ref":"#/components/schemas/client-credentials-grant"},{"$ref":"#/components/schemas/registration-code-grant"},{"$ref":"#/components/schemas/authorization-code-grant"},{"$ref":"#/components/schemas/refresh-token-grant"}]},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"type":"object","properties":{"X-External-Correlation-Id":{"type":"string","format":"uuid","maxLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed back when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-External-Correlation-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was included in the request. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"x-trace-id":{"type":"string","description":"Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.","example":"fba501b6d453b96789f52338f019341f"}}},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"invalid_request"},"error_description":{"type":"string","example":"Missing grant type"}}},"id":"schema_624"},"schema_625":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"invalid_grant"},"error_description":{"type":"string","example":"Invalid user credentials."}}},"id":"schema_625"},"schema_626":{"kind":"json-schema","data":{"type":"object"},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","description":"Number of seconds to wait before retrying the request.","example":5},"X-Rate-Limited-By":{"type":"string","description":"Identifies the rate limiter that triggered the 429 response.","example":"wise-public-api"},"X-External-Correlation-Id":{"type":"string","format":"uuid","maxLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed back when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-External-Correlation-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was included in the request. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"x-trace-id":{"type":"string","description":"Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.","example":"fba501b6d453b96789f52338f019341f"}}},"id":"schema_627"},"schema_628":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"type":"string","enum":["ES256","ES384","ES512","PS256","PS384","PS512","RSA_OAEP_256"]},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"string","enum":["PAYLOAD_SIGNING","PAYLOAD_ENCRYPTION"]},"id":"schema_630"},"schema_631":{"kind":"json-schema","data":{"type":"object","properties":{"keyId":{"type":"string","format":"UUID","description":"ID of the key in UUID format."},"version":{"type":"integer","format":"int32","description":"Version of the public key issued."},"keyMaterial":{"type":"object","properties":{"algorithm":{"type":"string","description":"Algorithm to be used with the key.","enum":["ES256","ES384","ES512","PS256","PS384","PS512","RSA_OAEP_256"]},"keyMaterial":{"type":"string","description":"Public key material."}}},"scope":{"type":"string","description":"Scope of the key.","enum":["PAYLOAD_SIGNING","PAYLOAD_ENCRYPTION"]}}},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"object","properties":{"keyId":{"type":"string","format":"uuid","description":"Unique public key identifier in UUID format."},"validFrom":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is valid from this date. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UTC)."},"children":[]}]}]}]},"validTill":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is valid until this date. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UTC)."},"children":[]}]}]}]},"scope":{"type":"string","description":"Scope of the payload operation.","enum":["PAYLOAD_SIGNING","PAYLOAD_ENCRYPTION"]},"publicKeyMaterial":{"type":"object","properties":{"algorithm":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Algorithm to be used for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature verification (Scope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_SIGNING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES384"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ES512"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS384"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PS512"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload encryption (Scope: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYLOAD_ENCRYPTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RSA_OAEP_256"},"children":[]}]}]}]}],"enum":["ES256","ES384","ES512","PS256","PS384","PS512","RSA_OAEP_256"]},"keyMaterial":{"type":"string","description":"Public key material in DER (Distinguished Encoding Rules) format and base64 encoded."}}}}},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"type":"object","properties":{"clientId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is currently not in use and will always return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"keyId":{"type":"string","format":"uuid","description":"Unique public key identifier in UUID format."},"scope":{"type":"string","description":"Scope of the payload operation.","enum":["PAYLOAD_SIGNING","PAYLOAD_ENCRYPTION"]},"validFrom":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is valid from this date. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UTC)."},"children":[]}]}]}]},"validTill":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is valid until this date. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UTC)."},"children":[]}]}]}]},"publicKeyMaterial":{"type":"object","properties":{"algorithm":{"type":"string","description":"Algorithm to be used for request signature verification or for response payload encryption."},"keyMaterial":{"type":"string","description":"Public key material in DER (Distinguished Encoding Rules) format and base64 encoded."}}},"deactivationTimestamp":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is currently not in use and will always return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_633"},"schema_634":{"kind":"json-schema","data":{"type":"string","enum":["application/jose+json"]},"id":"schema_634"},"schema_635":{"kind":"json-schema","data":{"type":"string","enum":["jws"]},"id":"schema_635"},"schema_636":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWS-encoded string. The payload before signing should contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with any text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded (JWS):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsInVybCI6Ii92MS9hdXRoL2pvc2UvcGxheWdyb3VuZC9qd3MifQ.eyJtZXNzYWdlIjoiVGhpcyBpcyBhbiBleGFtcGxlIGZyb20gZG9jcy53aXNlLmNvbSJ9.AS9QHdkWvUEn0LxQEMPRBzlceN78J-Le-Qm1XIkkSBpsGdc0WM0MZTIGFEAJEcWeUR2M-abtd5DRdar4hLzs9apPAQ-GT70SIDV6pX9-4UKfIfzJ4g305zCoHflTfn-ijvI7XrVR_yr7xO9GJo86bfBqAX_m5uuxyU7Jy9gM1epd8HcC\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsInVybCI6Ii92MS9hdXRoL2pvc2UvcGxheWdyb3VuZC9qd3MifQ.eyJtZXNzYWdlIjoiVGhpcyBpcyBhbiBleGFtcGxlIGZyb20gZG9jcy53aXNlLmNvbSJ9.AS9QHdkWvUEn0LxQEMPRBzlceN78J-Le-Qm1XIkkSBpsGdc0WM0MZTIGFEAJEcWeUR2M-abtd5DRdar4hLzs9apPAQ-GT70SIDV6pX9-4UKfIfzJ4g305zCoHflTfn-ijvI7XrVR_yr7xO9GJo86bfBqAX_m5uuxyU7Jy9gM1epd8HcC\n"},"children":[]}]}]},"id":"schema_636"},"schema_637":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWS-encoded string. When decoded, the response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The original message prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jose-playground-response-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Message length is limited to 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Original HTTP request method name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of decoded response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n"},"children":[]}]}]},"id":"schema_637"},"schema_638":{"kind":"json-schema","data":{"type":"string","enum":["jwe"]},"id":"schema_638"},"schema_639":{"kind":"json-schema","data":{"type":"string"},"id":"schema_639"},"schema_640":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string. When decrypted, the response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The response message is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jose-playground-response-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Original HTTP request method name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of decrypted response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"message\": \"jose-playground-response-\",\n \"method\": \"GET\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"message\": \"jose-playground-response-\",\n \"method\": \"GET\"\n}\n"},"children":[]}]}]},"id":"schema_640"},"schema_641":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string. The payload before encryption should contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with any text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded (JWE):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W_WPBDXclMryaywqAB-_yC1hUYukKmZxByhE9d1G8hClc2HpewkryILGJW4uVTUeRdo1oVWd68TPIqi7bqMGUsrT-3MI4ggVSjC1rf8Lf1xTZ8-GHjSPso8tFBXnydOKzggi6fnfk98BIW76Rnxkn6sW79LH5NgN1spTOoh8-tI3i_wbHdqJOxTReaUNMYZobm7wxedZcRxhsaSrVqx2qdELeqkfwgvB1DRbHTF_PTe4W0ibMbcJivHjiDf6oAV9vXgVhYb66rhB43pgdFDv4nY1mkQC45R5T6CBdzv80EdAVOj1G4bktHyJWaJzHVsGozpxsNj3bt1AopyvDO8tsw.WLOO5WH4ZpBPi-8B.0g3eUpQPvRIaTbgUi6sH0WejsJ1nLWDGnDKTktZrkquLQlCMmIguj0I5UCyqXEo.URtTniRvfGxrKRLK63trug\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W_WPBDXclMryaywqAB-_yC1hUYukKmZxByhE9d1G8hClc2HpewkryILGJW4uVTUeRdo1oVWd68TPIqi7bqMGUsrT-3MI4ggVSjC1rf8Lf1xTZ8-GHjSPso8tFBXnydOKzggi6fnfk98BIW76Rnxkn6sW79LH5NgN1spTOoh8-tI3i_wbHdqJOxTReaUNMYZobm7wxedZcRxhsaSrVqx2qdELeqkfwgvB1DRbHTF_PTe4W0ibMbcJivHjiDf6oAV9vXgVhYb66rhB43pgdFDv4nY1mkQC45R5T6CBdzv80EdAVOj1G4bktHyJWaJzHVsGozpxsNj3bt1AopyvDO8tsw.WLOO5WH4ZpBPi-8B.0g3eUpQPvRIaTbgUi6sH0WejsJ1nLWDGnDKTktZrkquLQlCMmIguj0I5UCyqXEo.URtTniRvfGxrKRLK63trug\n"},"children":[]}]}]},"id":"schema_641"},"schema_642":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string. When decrypted, the response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The original message prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jose-playground-response-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Message length is limited to 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Original HTTP request method name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of decrypted response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n"},"children":[]}]}]},"id":"schema_642"},"schema_643":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string. The payload before encryption should contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with any text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded (JWE):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.rVqOhX92u637hqwrw96rqA48e7NhMZVeWvUZwA4OAwOa_sBVcpXecd6qivPfZ-CuhRaD4gNKUlUJnTedBwOh5hcDZELRWThtwNiTZKaDS_ZNDjJf1r0VQPj65nT2ikfPAP-S6cYCy6JbWXivf7Jwq6lus-QydmxoLlVRvAuROFe-HzlH0-JhlwOdhPwbwl1AGx64qEir7oOn5VezJvpx3sscipm3w30mfoFc7pLlscMijMNFUwngXCLmgpno1rC_ZDzRcEycVbwvgKW75jO25UyEJif25MdE0UJUx4IT6MDviHqtBXO4OQpwhd_W6jVk-PlZ1WkZyOZqpi8HLKGo8Q.eFHqPV-mcBC82Ga2.W9o2BT7Q-vEUA2u3n4gaSdfQY_4svVj0-jwjcXmlBraZEKmtTW_A1ygvr8b9iHfS9fkxL8H_6S_oEcqzFqTKmNTzwe2V0cRY-kvzsKI.lO2gETmo2WocPZoTpU-pkQ\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.rVqOhX92u637hqwrw96rqA48e7NhMZVeWvUZwA4OAwOa_sBVcpXecd6qivPfZ-CuhRaD4gNKUlUJnTedBwOh5hcDZELRWThtwNiTZKaDS_ZNDjJf1r0VQPj65nT2ikfPAP-S6cYCy6JbWXivf7Jwq6lus-QydmxoLlVRvAuROFe-HzlH0-JhlwOdhPwbwl1AGx64qEir7oOn5VezJvpx3sscipm3w30mfoFc7pLlscMijMNFUwngXCLmgpno1rC_ZDzRcEycVbwvgKW75jO25UyEJif25MdE0UJUx4IT6MDviHqtBXO4OQpwhd_W6jVk-PlZ1WkZyOZqpi8HLKGo8Q.eFHqPV-mcBC82Ga2.W9o2BT7Q-vEUA2u3n4gaSdfQY_4svVj0-jwjcXmlBraZEKmtTW_A1ygvr8b9iHfS9fkxL8H_6S_oEcqzFqTKmNTzwe2V0cRY-kvzsKI.lO2gETmo2WocPZoTpU-pkQ\n"},"children":[]}]}]},"id":"schema_643"},"schema_644":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string using direct encryption. The response is encrypted with the original content encryption key from the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response JOSE headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"enc\": \"A256GCM\", \"alg\": \"dir\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"enc\": \"A256GCM\", \"alg\": \"dir\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When decrypted, the response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The original message prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jose-playground-response-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Message length is limited to 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Original HTTP request method name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of decrypted response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n"},"children":[]}]}]},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"type":"string","enum":["jws+jwe"]},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"type":"string","enum":["identity"]},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string containing a signed JWS. The payload before signing and encryption should contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with any text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original payload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"message\": \"This is an example from docs.wise.com\"}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded (JWS+JWE):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcxWwgtjEPkOnLdVNyH9ncZi5Y9xQbjD4sYJn8vEQmxKHDw5s14sWhdexSNAPTVMSyzwJaA-LRL0tZTEuQ.ohD4LLjImiKOV4Tu.Rgp9mc2JD6m9Zm5htSqrejwWYy0_hIylYdLD39ZCR-VnQ2VX-Tot8kKGeNncnv7hJ_ApANWiJpKJbiM.5hNt-uaxuOkOraGGZSmsig\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcxWwgtjEPkOnLdVNyH9ncZi5Y9xQbjD4sYJn8vEQmxKHDw5s14sWhdexSNAPTVMSyzwJaA-LRL0tZTEuQ.ohD4LLjImiKOV4Tu.Rgp9mc2JD6m9Zm5htSqrejwWYy0_hIylYdLD39ZCR-VnQ2VX-Tot8kKGeNncnv7hJ_ApANWiJpKJbiM.5hNt-uaxuOkOraGGZSmsig\n"},"children":[]}]}]},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE-encoded string containing a signed JWS. After decryption (JWE) and signature verification (JWS), the response contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The original message prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jose-playground-response-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Message length is limited to 100 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Original HTTP request method name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of decrypted and decoded response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"message\": \"jose-playground-response-This is an example from docs.wise.com\",\n \"method\": \"POST\"\n}\n"},"children":[]}]}]},"id":"schema_649"},"schema_650":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"type":"object","required":["email","registrationCode"],"properties":{"email":{"type":"string","format":"email","description":"New user's email address.","example":"user@email.com"},"registrationCode":{"type":"string","minLength":32,"description":"Randomly generated registration code that is unique to this user and request. At least 32 characters long.\nYou need to store registration code to obtain access token on behalf of this newly created user in next step.\nPlease apply the same security standards to handling registration code as if it was a password.\n","example":"a]#Et6(yLW@mq4Ky_+EAjXxpHGq7*&lr"},"language":{"type":"string","description":"User default language for UI and email communication.\nAllowed values: EN, US, PT, ES, FR, DE, IT, JA, RU, PL, HU, TR, RO, NL, HK.\nDefault value: EN.\n","example":"EN"}}},"id":"schema_651"},"schema_652":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"},"arguments":{"type":"array","items":{"type":"string"}}}}}}},"id":"schema_652"},"schema_653":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"User's email address.","example":"test@wise.com"}}},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"type":"object","properties":{"exists":{"type":"boolean","description":"Whether a user with this email already exists."}}},"id":"schema_654"},"schema_655":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Contact email address.","example":"new-user@email.com"}}},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Contact email address."}}},"id":"schema_656"},"schema_657":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_657"},"schema_658":{"kind":"json-schema","data":{"title":"User State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-18","2.0.0":"#/components/schemas/v2.0.0-18"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-18"},{"$ref":"#/components/schemas/v2.0.0-18"}]},"id":"schema_658"},"schema_659":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"}}},"id":"schema_659"},"schema_660":{"kind":"json-schema","data":{"type":"object","required":["registrationCode"],"properties":{"registrationCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registration_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/user/usercreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating the user"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"type":"object","properties":{"claimAccountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"claim_account_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be used in the redirect to Wise."},"children":[]}]}]}]}}},"id":"schema_661"},"schema_662":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/profile"}},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"type":"object","required":["firstName","lastName","dateOfBirth","address","contactDetails"],"properties":{"firstName":{"type":"string","maxLength":30,"description":"First name (including middle names).","example":"Oliver"},"lastName":{"type":"string","maxLength":30,"description":"Last name.","example":"Wilson"},"preferredName":{"type":"string","maxLength":30,"description":"Preferred first name, if different to the legal first name.","example":"Olivia"},"firstNameInKana":{"type":["string","null"],"description":"First name in Katakana. Required for from-JPY personal transfers.","example":null},"lastNameInKana":{"type":["string","null"],"description":"Last name in Katakana. Required for from-JPY personal transfers.","example":null},"address":{"type":"object","required":["addressFirstLine","city","countryIso3Code"],"properties":{"addressFirstLine":{"type":"string","description":"First line of address.","example":"50 Sunflower Ave"},"city":{"type":"string","description":"City.","example":"Phoenix"},"countryIso3Code":{"type":"string","description":"3 letter country code (lower case).","example":"usa"},"postCode":{"type":"string","description":"Postal code.","example":"10025"},"stateCode":{"type":"string","maxLength":5,"description":"State code. Required for US, CA, BR and AU addresses.","example":"AZ"}}},"nationality":{"type":"string","description":"3 letter country code (lower case).","example":"usa"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1977-07-01"},"externalCustomerId":{"type":"string","description":"An external reference identifier mapping the customer of this profile to your system.","example":"12345-oliver-wilson"},"contactDetails":{"type":"object","required":["email","phoneNumber"],"properties":{"email":{"type":"string","description":"Contact email address. Please speak with your integration account manager for details on how customer communication is handled for your integration.","example":"o.wilson@example.com"},"phoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact phone number in international phone number format, example \"+1408XXXXXXX\"."},"children":[]}]}]}],"example":"+3725064992"}}},"occupations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation field code - this field accepts any job or occupation that the customer does, as the only occupation format currently accepted is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FREE_FORM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Software Engineer"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation field format. As of now, it only accepts the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FREE_FORM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FREE_FORM"}}}}}},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique profile ID.","example":30000001},"type":{"type":"string","description":"Profile type.","enum":["PERSONAL"],"example":"PERSONAL"},"details":{"type":"object","description":"Profile details.","properties":{"firstName":{"type":"string","description":"First name (including middle names).","example":"Oliver"},"lastName":{"type":"string","description":"Last name.","example":"Wilson"},"preferredName":{"type":"string","description":"Preferred first name.","example":"Olivia"},"firstNameInKana":{"type":["string","null"],"description":"First name in Katakana.","example":null},"lastNameInKana":{"type":["string","null"],"description":"Last name in Katakana.","example":null},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","example":"50 Sunflower Ave"},"city":{"type":"string","example":"Phoenix"},"countryIso3Code":{"type":"string","example":"usa"},"postCode":{"type":"string","example":"10025"},"stateCode":{"type":"string","example":"AZ"}}},"nationality":{"type":"string","description":"3 letter country code (lower case).","example":"usa"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1977-07-01"},"externalCustomerId":{"type":"string","description":"External reference identifier in your system.","example":"12345-oliver-wilson"},"contactDetails":{"type":"object","properties":{"email":{"type":"string","example":"o.wilson@example.com"},"phoneNumber":{"type":"string","example":"+3725064992"}}},"occupations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"Software Engineer"},"format":{"type":"string","example":"FREE_FORM"}}}},"localizedInformation":{"type":"array","description":"Localized information for the profile.","items":{"type":"object"}}}}}},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"object","properties":{"businessName":{"type":"string","description":"Business name.","example":"ABC Logistics Ltd"},"businessNameInKatakana":{"type":["string","null"],"description":"Business name in Katakana (only for Japanese businesses).","example":null},"businessFreeFormDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business free form description. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is not provided for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" companyType, the profile should not be allowed to create a transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the rest of the companyTypes, it is highly recommended to always provide the business' description, to avoid payment issues such as suspensions. Wise will send a request for information (RFI) if this detail is not provided."},"children":[]}]}]}],"example":"Biz free form desc"},"registrationNumber":{"type":"string","description":"Business registration number.","example":"12144939"},"acn":{"type":["string","null"],"description":"Australian Company Number (only for Australian businesses).","example":null},"abn":{"type":["string","null"],"description":"Australian Business Number (only for Australian businesses).","example":null},"arbn":{"type":["string","null"],"description":"Australian Registered Body Number (only for Australian businesses).","example":null},"companyType":{"type":"string","description":"Company legal form.","enum":["LIMITED","PARTNERSHIP","SOLE_TRADER","LIMITED_BY_GUARANTEE","LIMITED_LIABILITY_COMPANY","FOR_PROFIT_CORPORATION","NON_PROFIT_CORPORATION","LIMITED_PARTNERSHIP","LIMITED_LIABILITY_PARTNERSHIP","GENERAL_PARTNERSHIP","SOLE_PROPRIETORSHIP","PRIVATE_LIMITED_COMPANY","PUBLIC_LIMITED_COMPANY","TRUST","OTHER"],"example":"LIMITED"},"companyRole":{"type":"string","description":"Role of person.","enum":["OWNER","DIRECTOR","OTHER"],"example":"OWNER"},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","description":"First line of address.","example":"1 A road"},"city":{"type":"string","description":"City.","example":"London"},"countryIso2Code":{"type":"string","description":"2 letter country code.","example":"gb"},"countryIso3Code":{"type":"string","description":"3 letter country code. Must be lowercase.","example":"gbr"},"postCode":{"type":"string","description":"Postal code.","example":"11111"},"stateCode":{"type":"string","description":"State code."}}},"externalCustomerId":{"type":"string","description":"An external reference identifier mapping the customer of this profile to your system.","example":"67890-biz-acct"},"actorEmail":{"type":"string","description":"Email of the actor.","example":"biz-acct@abcl.com"},"industryCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more industry categories classifying the business. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of valid values."},"children":[]}]}]}],"minItems":1,"items":{"type":"string"},"example":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"]},"operationalAddresses":{"type":"array","description":"List of operational addresses.","items":{"type":"object","properties":{"addressFirstLine":{"type":"string","example":"1 A road"},"city":{"type":"string","example":"London"},"countryIso2Code":{"type":"string","example":"gb"},"countryIso3Code":{"type":"string","example":"gbr"},"postCode":{"type":"string","example":"11111"},"stateCode":{"type":"string"}}}},"webpage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business webpage. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is not provided for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" companyType, the profile should not be allowed to create a transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the rest of the companyTypes, it is highly recommended to always provide the business' website, to avoid payment issues such as suspensions. Wise will send a request for information (RFI) if this detail is not provided."},"children":[]}]}]}],"example":"https://abc-logistics.com"},"businessRepresentative":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business representative details. Provide either the full representative details or just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessRepresentativeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link an existing representative."},"children":[]}]}]}],"properties":{"businessRepresentativeId":{"type":"integer","description":"ID of a Business Representative. This can be obtained from a previous call to create a business profile, in which case the same Business Representative is linked to the current business effectively sharing it across multiple businesses. When the Business Representative ID is provided, it is the only field required and none of the other fields should be provided."},"firstName":{"type":"string","description":"First name of the person representing the business (including middle names). Required unless Business Representative ID is provided.","example":"Oliver"},"lastName":{"type":"string","description":"Last name of the person representing the business. Required unless Business Representative ID is provided.","example":"Wilson"},"preferredName":{"type":"string","description":"Preferred first name, if different to the legal first name.","example":"Olivia"},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","description":"First line of address. Required unless Business Representative ID is provided.","example":"50 Sunflower Ave"},"city":{"type":"string","description":"City. Required unless Business Representative ID is provided.","example":"Phoenix"},"countryIso3Code":{"type":"string","description":"3 letter country code (lower case). Required unless Business Representative ID is provided.","example":"usa"},"postCode":{"type":"string","description":"Postal code.","example":"10025"},"stateCode":{"type":"string","description":"State code (max 5 chars). Required for US, CA, BR and AU addresses unless Business Representative ID is provided.","example":"AZ"}}},"contactDetails":{"type":"object","properties":{"email":{"type":"string","description":"Contact email address. Required unless Business Representative ID is provided.","example":"o.wilson@example.com"},"phoneNumber":{"type":"string","description":"Contact phone number in international phone number format. Required unless Business Representative ID is provided.","example":"+3725064992"}}},"dateOfBirth":{"type":"string","description":"Date of birth. Required unless Business Representative ID is provided.","example":"1977-07-01"}}}}},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"type":"object","properties":{"firstName":{"type":"string","maxLength":30,"description":"First name (including middle names).","example":"Oliver"},"lastName":{"type":"string","maxLength":30,"description":"Last name.","example":"Wilson"},"preferredName":{"type":"string","maxLength":30,"description":"Preferred first name, if different to the legal first name.","example":"Olivia"},"firstNameInKana":{"type":["string","null"],"description":"First name in Katakana. Required for from-JPY personal transfers.","example":null},"lastNameInKana":{"type":["string","null"],"description":"Last name in Katakana. Required for from-JPY personal transfers.","example":null},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","description":"First line of address.","example":"50 Sunflower Ave"},"city":{"type":"string","description":"City.","example":"Phoenix"},"countryIso3Code":{"type":"string","description":"3 letter country code (ISO3, lower case).","example":"usa"},"postCode":{"type":"string","description":"Postal code or ZIP code.","example":"10025"},"stateCode":{"type":"string","maxLength":5,"description":"State code. Required for US, CA, BR and AU addresses.","example":"AZ"}}},"nationality":{"type":"string","description":"3 letter country code (ISO3, lower case).","example":"usa"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1977-07-01"},"contactDetails":{"type":"object","properties":{"email":{"type":"string","description":"Contact email address. Please speak with your integration account manager for details on how customer communication is handled for your integration.","example":"o.wilson@example.com"},"phoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact phone number in international phone number format, example \"+1408XXXXXXX\"."},"children":[]}]}]}],"example":"+3725064992"}}},"externalCustomerId":{"type":"string","description":"An external reference identifier mapping the customer of this profile to your system.","example":"12345-oliver-wilson"},"occupations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation field code - this field accepts any job or occupation that the customer does, as the only occupation format currently accepted is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FREE_FORM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Software Engineer"},"format":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation field format. As of now, it only accepts the value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"FREE_FORM\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"FREE_FORM"}}}}}},"id":"schema_666"},"schema_667":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Business profile ID. This must match the business profile ID supplied in the URL.","example":14599371},"businessName":{"type":"string","description":"Business name.","example":"ABC Logistics Ltd"},"businessNameInKatakana":{"type":["string","null"],"description":"Business name in Katakana (only for Japanese businesses).","example":null},"businessFreeFormDescription":{"type":"string","description":"Business free form description.","example":"Biz free form desc"},"registrationNumber":{"type":"string","description":"Business registration number.","example":"12144939"},"acn":{"type":["string","null"],"description":"Australian Company Number (only for Australian businesses).","example":null},"abn":{"type":["string","null"],"description":"Australian Business Number (only for Australian businesses).","example":null},"arbn":{"type":["string","null"],"description":"Australian Registered Body Number (only for Australian businesses).","example":null},"companyType":{"type":"string","description":"Company legal form.","enum":["LIMITED","PARTNERSHIP","SOLE_TRADER","LIMITED_BY_GUARANTEE","LIMITED_LIABILITY_COMPANY","FOR_PROFIT_CORPORATION","NON_PROFIT_CORPORATION","LIMITED_PARTNERSHIP","LIMITED_LIABILITY_PARTNERSHIP","GENERAL_PARTNERSHIP","SOLE_PROPRIETORSHIP","PRIVATE_LIMITED_COMPANY","PUBLIC_LIMITED_COMPANY","TRUST","OTHER"],"example":"LIMITED"},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","description":"First line of address.","example":"1 A road"},"city":{"type":"string","description":"City.","example":"London"},"countryIso2Code":{"type":"string","description":"2 letter country code.","example":"gb"},"countryIso3Code":{"type":"string","description":"3 letter country code. Must be lowercase.","example":"gbr"},"postCode":{"type":"string","description":"Postal code.","example":"11111"},"stateCode":{"type":"string","maxLength":5,"description":"State code."}}},"companyRole":{"type":"string","description":"Role of person.","enum":["OWNER","DIRECTOR","OTHER"],"example":"OWNER"},"externalCustomerId":{"type":"string","description":"An external reference identifier mapping the customer of this profile to your system.","example":"67890-biz-acct"},"industryCategories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more industry categories classifying the business. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"guides/product/kyc/business-categories"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list of valid values."},"children":[]}]}]}],"minItems":1,"items":{"type":"string"},"example":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"]},"operationalAddresses":{"type":"array","description":"List of operational addresses.","items":{"type":"object","properties":{"addressFirstLine":{"type":"string","example":"1 A road"},"city":{"type":"string","example":"London"},"countryIso2Code":{"type":"string","example":"gb"},"countryIso3Code":{"type":"string","example":"gbr"},"postCode":{"type":"string","example":"11111"},"stateCode":{"type":"string","maxLength":5}}}},"webpage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business webpage. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is not provided for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" companyType, the profile should not be allowed to create a transfer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the rest of the companyTypes, it is highly recommended to always provide the business' website, to avoid payment issues such as suspensions. Wise will send a request for information (RFI) if this detail is not provided."},"children":[]}]}]}],"example":"https://abc-logistics.com"}}},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"type":"object","properties":{"updateContext":{"type":"string","description":"Context of the update.","enum":["UPDATE_DETAILS","TRANSFER_OF_AUTHORISATION"],"example":"UPDATE_DETAILS"},"firstName":{"type":"string","description":"First name of the person representing the business (including middle names).","example":"Oliver"},"lastName":{"type":"string","description":"Last name of the person representing the business.","example":"Wilson"},"preferredName":{"type":"string","description":"Preferred first name, if different to the legal first name.","example":"Olivia"},"address":{"type":"object","properties":{"addressFirstLine":{"type":"string","description":"First line of address.","example":"50 Sunflower Ave"},"city":{"type":"string","description":"City.","example":"Phoenix"},"countryIso3Code":{"type":"string","description":"3 letter country code (lower case).","example":"usa"},"postCode":{"type":"string","description":"Postal code.","example":"10025"},"stateCode":{"type":"string","description":"State code (max 5 chars). Required for US, CA, BR and AU addresses.","example":"AZ"}}},"contactDetails":{"type":"object","properties":{"email":{"type":"string","description":"Contact email address of the person representing the business. Please speak with your integration account manager for details on how customer communication is handled for your integration.","example":"o.wilson@example.com"},"phoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact phone number in international phone number format, example \"+1408XXXXXXX\" of the person representing the business. Please speak with your integration account manager for details on how customer communication is handled for your integration."},"children":[]}]}]}],"example":"+3725064992"}}},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1977-07-01"},"actorEmail":{"type":"string","description":"Email of the actor.","example":"biz-acct@abcl.com"}}},"id":"schema_668"},"schema_669":{"kind":"json-schema","data":{"type":"object","properties":{"firstName":{"type":"string","description":"Person first name in document.","example":"Oliver"},"lastName":{"type":"string","description":"Person last name in document.","example":"Wilson"},"type":{"type":"string","description":"Document type.","enum":["DRIVERS_LICENCE","IDENTITY_CARD","GREEN_CARD","MY_NUMBER","PASSPORT","SSN","EMIRATES_EMPLOYER","EMIRATES_PLACE_OF_BIRTH","CPF_CNPJ","FINANCIAL_CAPACITY_BR","OTHER"],"example":"IDENTITY_CARD"},"uniqueIdentifier":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document number or value. Must be digits only when SSN or FINANCIAL_CAPACITY_BR."},"children":[]}]}]}],"example":"AA299822313"},"issueDate":{"type":"string","description":"Document issue date.","example":"2017-12-31"},"issuerCountry":{"type":"string","description":"Issued by country code. For example \"US\".","example":"EE"},"issuerState":{"type":"string","description":"Issued by state code. For example \"NY\".","example":""},"expiryDate":{"type":"string","description":"Document expiry date.","example":"2027-12-31"},"nationality":{"type":"string","description":"2 characters ISO country code."},"employerName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the employer. Type must be EMIRATES_EMPLOYER."},"children":[]}]}]}]},"employerCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The city of the employer. Type must be EMIRATES_EMPLOYER."},"children":[]}]}]}]},"employerCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 characters ISO country code. Type must be EMIRATES_EMPLOYER."},"children":[]}]}]}]},"birthCity":{"type":"string","description":"The city of birth of the customer."},"birthCountry":{"type":"string","description":"2 characters ISO country code."}}},"id":"schema_669"},"schema_670":{"kind":"json-schema","data":{"type":"object","properties":{"errorMessage":{"type":["string","null"],"example":null},"success":{"type":"boolean","example":true}}},"id":"schema_670"},"schema_671":{"kind":"json-schema","data":{"type":"object","properties":{"errorMessage":{"type":"string","example":"Financial capacity can't be added because no tax ID has been submitted for the profile."},"success":{"type":"boolean","example":false}}},"id":"schema_671"},"schema_672":{"kind":"json-schema","data":{"type":"object","required":["type","clientId"],"properties":{"clientId":{"type":"string","description":"The partner's client ID.","example":"mercury"},"firstName":{"type":"string","description":"Person first name in document.","example":"Oliver"},"lastName":{"type":"string","description":"Person last name in document.","example":"Wilson"},"type":{"type":"string","description":"Document type.","enum":["DRIVERS_LICENCE","IDENTITY_CARD","GREEN_CARD","MY_NUMBER","PASSPORT","SSN","EMIRATES_EMPLOYER","EMIRATES_PLACE_OF_BIRTH","CPF_CNPJ","FINANCIAL_CAPACITY_BR","OTHER"],"example":"IDENTITY_CARD"},"uniqueIdentifier":{"type":"string","maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document number or value. Must be digits only when SSN or FINANCIAL_CAPACITY_BR."},"children":[]}]}]}],"example":"AA299822313"},"issueDate":{"type":"string","description":"Document issue date.","example":"2017-12-31"},"issuerCountry":{"type":"string","description":"Issued by country code. For example \"US\".","example":"EE"},"issuerState":{"type":"string","description":"Issued by state code. For example \"NY\".","example":""},"expiryDate":{"type":"string","description":"Document expiry date.","example":"2027-12-31"},"nationality":{"type":"string","description":"2 characters ISO country code."},"sex":{"type":"string","description":"Sex as stated in the document.","enum":["MALE","FEMALE"],"example":"MALE"},"placeOfBirth":{"type":"string","description":"Place of birth as stated in the document.","example":"London"}}},"id":"schema_672"},"schema_673":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"not.allowed.for.clientId"},"message":{"type":"string"},"field":{"type":"string"}}}}}},"id":"schema_673"},"schema_674":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"Director first name.","example":"John"},"lastName":{"type":"string","description":"Director last name.","example":"Doe"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1982-05-20"},"countryOfResidenceIso3Code":{"type":"string","description":"3 character country code.","example":"usa"}}}},"id":"schema_674"},"schema_675":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/director"}},"id":"schema_675"},"schema_676":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Owner full name.","example":"John Doe"},"dateOfBirth":{"type":"string","description":"Date of birth.","example":"1982-05-20"},"countryOfResidenceIso3Code":{"type":"string","description":"3 character country code.","example":"usa"},"addressFirstLine":{"type":"string","description":"First line of address.","example":"123 Fake St"},"postCode":{"type":"string","description":"Address post code.","example":"FK 12345"},"ownershipPercentage":{"type":["integer","null"],"format":"int32","description":"Percentage of ownership.","example":30}}}},"id":"schema_676"},"schema_677":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ubo"}},"id":"schema_677"},"schema_678":{"kind":"json-schema","data":{"type":"object","properties":{"routes":{"type":"array","items":{"type":"object","properties":{"source_currency":{"type":"string","description":"ISO 4217 currency code.","example":"GBP"},"maximum_entitled_amount":{"type":"number","description":"Maximum entitled amount that can be transferred with the user's given verification state.","example":100000},"current_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current verification status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Profile is verified. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_entitled_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be ignored (note that some regional limits may still apply)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_entitled_amount: 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Profile is not verified. Any payments from the user will be delayed by verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_entitled_amount > 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Profile is not yet verified but the user can make payments up to a cumulative limit. Once reached, further payments may be delayed by additional verification requirements."},"children":[]}]}]}]}],"enum":["verified","not_verified"],"example":"verified"}}}},"request_id":{"type":"string","description":"Request identifier.","example":"e66da5f6-2456-403c-bfcb-908885ee1a61"}}},"id":"schema_678"},"schema_679":{"kind":"json-schema","data":{"title":"Overdraft Limit Threshold Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-14","2.0.0":"#/components/schemas/v2.0.0-14"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-14"},{"$ref":"#/components/schemas/v2.0.0-14"}]},"id":"schema_679"},"schema_680":{"kind":"json-schema","data":{"title":"Profile State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-15","2.0.0":"#/components/schemas/v2.0.0-15"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-15"},{"$ref":"#/components/schemas/v2.0.0-15"}]},"id":"schema_680"},"schema_681":{"kind":"json-schema","data":{"title":"Profile Verification State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-16","2.0.0":"#/components/schemas/v2.0.0-16"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-16"},{"$ref":"#/components/schemas/v2.0.0-16"}]},"id":"schema_681"},"schema_682":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ActivityResourceType"},"id":"schema_682"},"schema_683":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ActivityStatus"},"id":"schema_683"},"schema_684":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2025-03-10T11:56:30.376Z"},"id":"schema_684"},"schema_685":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2025-03-30T23:59:59.999Z"},"id":"schema_685"},"schema_686":{"kind":"json-schema","data":{"type":"string","example":""},"id":"schema_686"},"schema_687":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_687"},"schema_688":{"kind":"json-schema","data":{"type":"object","description":"Response containing a list of activities for a profile.","properties":{"cursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination cursor. Pass this value as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextCursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to fetch the next page of results. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when there are no more pages."},"children":[]}]}]}]},"activities":{"type":"array","description":"Array of activity objects.","items":{"$ref":"#/components/schemas/Activity"}}}},"id":"schema_688"},"schema_689":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"id":"schema_689"},"schema_690":{"kind":"json-schema","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the underlying action or process this KYC Review is for. Usually a reference to which product this KYC Review is for (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a reference to a KYC process on the profile that isn't related to a specific product (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFRESH_CYCLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPAPERING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following types are available when creating a KYC Review using this endpoint:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROACTIVE_SEND_MONEY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]}]}]}]}],"enum":["QUOTE","PROACTIVE_SEND_MONEY","CARD"],"example":"QUOTE"},"triggerData":{"type":"object","description":"Object containing data of the underlying product object that triggered the KYC Review.\n","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the underlying product object. For example, if type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" then this would be the quote ID. This ID might be null when referencing an ID isn't meaningful. As an example, there's only ever one active refresh cycle per profile so referencing by ID isn't useful."},"children":[]}]}]}],"example":"ba83a43a-f623-46f0-956d-196c13e2ab01"}}}}},"id":"schema_690"},"schema_691":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_691"},"schema_692":{"kind":"json-schema","data":{"type":"integer","default":100,"maximum":100},"id":"schema_692"},"schema_693":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/kyc-review"}},"id":"schema_693"},"schema_694":{"kind":"json-schema","data":{"type":"object","required":["redirectUrl"],"properties":{"redirectUrl":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected at the end of the flow. Can contain query params and path fragments. It has to be a valid URL as per "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc2396.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 2396"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://example.com"}}},"id":"schema_694"},"schema_695":{"kind":"json-schema","data":{"type":"string","enum":["ACCOUNT_INTENT","ACCOUNT_PURPOSE","ANNUAL_VOLUME","BUSINESS_ANNUAL_INCOME","BUSINESS_AUTHORISATION_ID","BUSINESS_AUTHORISATION_LETTER","BUSINESS_CONTROLLING_PERSON","BUSINESS_DIRECTORS_CHECK","BUSINESS_INCOME_CLASSIFICATION","BUSINESS_MONTHLY_VOLUME","BUSINESS_REGISTRATION_DOCS","BUSINESS_SHAREHOLDER_CONTACT_DETAILS","BUSINESS_SHAREHOLDERS_CHECK","BUSINESS_SOURCE_OF_WEALTH","BUSINESS_SOURCE_OF_WEALTH_INFO","BUSINESS_SOURCE_OF_WEALTH_PROOF","BUSINESS_ULTIMATE_BENEFICIAL_OWNER_ID","BUSINESS_USE_CASE","ID_DOCUMENT","INCOME","INDIA_TRANSFER_PURPOSE","JPN_BUSINESS_CERT","JPN_PERSONAL_MYNUMBER","PROOF_OF_TRADING_ADDRESS","SOURCE_OF_FUNDS","SOURCE_OF_WEALTH","SOURCE_OF_WEALTH_INFO","SOURCE_OF_WEALTH_PROOF","TAX_RESIDENCY","USE_CASE_COUNTRIES"]},"id":"schema_695"},"schema_696":{"kind":"json-schema","data":{"type":"object","required":["submissionData"],"properties":{"submissionData":{"type":"string","format":"application/json","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON string containing the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an object whose fields vary by requirement type. Some requirement types do not require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the submission version, currently "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"V1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kycReviewId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the ID of the KYC Review this submission belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the JSON payload would look like below, but it should be included as a string value in the multipart form field:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"data\": {\n \"accountPurpose\": \"SENDING_MONEY_TO_FRIENDS_OR_FAMILY\"\n },\n \"version\": \"V1\",\n \"kycReviewId\": \"93a903ea-636c-4c86-a25c-cf6d2bd00e81\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"data\": {\n \"accountPurpose\": \"SENDING_MONEY_TO_FRIENDS_OR_FAMILY\"\n },\n \"version\": \"V1\",\n \"kycReviewId\": \"93a903ea-636c-4c86-a25c-cf6d2bd00e81\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/kyc-requirement-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure and accepted values for each requirement type."},"children":[]}]}]}]},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more files to upload. Required for certain requirement types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 3 accepted types for documents, they must be provided with the below content-type/Mime-type and have a matching file extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ContentType/MimeType & file extension:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".png"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".pdf"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/wise-kyc/kyc-requirement-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC requirement types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for which types require files."},"children":[]}]}]}]}}},"id":"schema_696"},"schema_697":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","example":"/errors/types/validation"},"title":{"type":"string","example":"Validation Error"},"status":{"type":"integer","example":400},"instance":{"type":"string"},"detail":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"ref":{"type":"string"},"detail":{"type":"string"},"attributes":{"type":"object"}}}}}},"id":"schema_697"},"schema_698":{"kind":"json-schema","data":{"title":"KYC Review State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"5.0.0":"#/components/schemas/v5.0.0-2","4.0.0":"#/components/schemas/v4.0.0-17","2.0.0":"#/components/schemas/v2.0.0-17"}},"oneOf":[{"$ref":"#/components/schemas/v5.0.0-2"},{"$ref":"#/components/schemas/v4.0.0-17"},{"$ref":"#/components/schemas/v2.0.0-17"}]},"id":"schema_698"},"schema_699":{"kind":"json-schema","data":{"oneOf":[{"title":"Personal Profile","type":"object","description":"Payload for Personal profile verification.","example":{"accountPurpose":"MOVING_SAVINGS","intendedCountries":["deu","esp"],"yearlyAnticipatedVolume":"0_2350","mainSourceOfIncome":"SALARY","annualIncome":"0_11500"},"properties":{"accountPurpose":{"type":"string","description":"The primary reason for using the account.","enum":["MOVING_SAVINGS","SENDING_MONEY_TO_FRIENDS_OR_FAMILY","GENERAL_LIVING_EXPENSES","BUYING_GOODS_OR_SERVICES_ABROAD","PAYING_FOR_MORTGAGE_OR_LOAN","PAYING_BILLS","RECEIVING_SALARY_OR_PENSION","INVESTING"]},"accountPurposeExplanation":{"type":"string","description":"Additional reasons and specific examples for using Wise account. This is a free-text field."},"intendedCountries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of ISO 3166-1 alpha-3 country codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2571942/what-countries-can-i-send-to"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lists of countries you can send money to with Wise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"}},"yearlyAnticipatedVolume":{"type":"string","description":"Expected yearly transaction volume in Euros.","enum":["0_2350","2351_6000","6001_11500","11501_60000","60001_175000","175001_+"]},"mainSourceOfIncome":{"type":"string","description":"Primary source of income. Must be submitted with annualIncome.","enum":["SALARY","INVESTMENTS","PENSION","INHERITANCE","LOAN","OTHER"]},"annualIncome":{"type":"string","description":"Expected annual income in Euros. Must be submitted with mainSourceOfIncome.","enum":["0_11500","11501_19000","19001_28500","28501_47500","47501_75000","75001_+"]},"incomeExplanation":{"type":"string","description":"Additional ways you earn money that were not identified in the provided documents. This is a free-text field."}}},{"title":"Business Profile","type":"object","description":"Payload for Business profile verification.","example":{"businessUseCase":["PAYING_SUPPLIERS_CONTRACTORS_OR_EMPLOYEES","PAYING_RENT_OR_UTILITIES"],"intendedCountries":["deu","esp"],"monthlyAnticipatedVolume":"0_1200","mainSourceOfFunding":"BUSINESS_LOAN"},"properties":{"businessUseCase":{"type":"array","description":"How the business intends to use the platform.","items":{"type":"string","enum":["INVESTING_IN_FUNDS_STOCKS_BONDS_OR_SIMILAR","DISTRIBUTING_COMPANY_PROFITS_OR_PAYING_DIVIDENDS","PAYING_MORTGAGE_BANK_LOAN_INSURANCE_OR_CREDIT","PAYING_FOR_GOODS_PROPERTIES_OR_SERVICES_ABROAD","PAYING_RENT_OR_UTILITIES","PAYING_SUPPLIERS_CONTRACTORS_OR_EMPLOYEES","PAYING_TAX_ON_PROFIT_OR_PROPERTY","TRANSFER_WITHIN_COMPANY_OR_GROUP","RECEIVE_INVESTMENTS_OR_FUNDS","RECEIVE_PAYMENTS_FROM_CLIENTS","DONATION","OTHER"]}},"intendedCountries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of ISO 3166-1 alpha-3 country codes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2571942/what-countries-can-i-send-to"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lists of countries you can send money to with Wise"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"}},"mainSourceOfFunding":{"type":"string","description":"Primary source of business funding.","enum":["REVENUE","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER"]},"monthlyAnticipatedVolume":{"type":"string","description":"Expected monthly transaction volume in Euros.","enum":["0_1200","1201_6000","6001_12000","12001_60000","60001_120000","120001_235000","235001_600000","600001_1200000","1200001_6000000","6000001_12000000","12000001_+"]}}}]},"id":"schema_699"},"schema_700":{"kind":"json-schema","data":{"type":"object","description":"Response payload for evidence upload result.","properties":{"overallStatus":{"type":"string","description":"Status of the entire request.","enum":["SUCCESS","PARTIAL_SUCCESS","FAIL"]},"results":{"type":"array","description":"Results for each evidence.","items":{"type":"object","properties":{"evidenceRequirementKey":{"type":"string","description":"Name of the evidence."},"result":{"type":"string","description":"Result for the evidence.","enum":["SUCCESS","FAIL"]},"message":{"type":"string","description":"Explanation of result for the evidence."}}}}}},"id":"schema_700"},"schema_701":{"kind":"json-schema","data":{"type":"object","description":"Request payload for uploading documents for verification","properties":{"files":{"type":"string","format":"binary","description":"Path of the files to be uploaded.","example":"@/Users/test/file.png"},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of document being uploaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read our guides on acceptable documents for each of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of wealth - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification#source-of-wealth-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id Proof - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2949801/how-does-wise-verify-my-identity?origin=search-ID+coument+"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address Proof - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2949804/how-does-wise-verify-my-address?origin=search-proof+of+address+"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trading Address Proof - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification#proof-of-trading-address-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Authorisation Letter - "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/kyc/partner-kyc/additional-verification#business-authorisation-letter-document"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guide"},"children":[]}]}]}]}]}],"enum":["SOURCE_OF_WEALTH","ID_PROOF","ADDRESS_PROOF","TRADING_ADDRESS_PROOF","BUSINESS_AUTH_REP_PROOF_BY_AUTH_LETTER"]}},"required":["files","documentType"]},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"type":"object","description":"Response payload containing required evidences for a profile.","properties":{"required_evidences":{"type":"array","description":"List of evidence types required to complete verification.","items":{"type":"string"}}}},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"title":"Additional Verification State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-13","2.0.0":"#/components/schemas/v2.0.0-13"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-13"},{"$ref":"#/components/schemas/v2.0.0-13"}]},"id":"schema_703"},"schema_704":{"kind":"json-schema","data":{"type":"object","required":["redirectUrl"],"properties":{"redirectUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected when the flow resolves."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will also include query parameters based on flow completion state and created recipient ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/recipient-creation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - Recipient Creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"example":"https://example.com/return"},"targetCurrency":{"type":"string","description":"Optional target currency used to start recipient requirements for a specific currency.","example":"USD"}}},"id":"schema_704"},"schema_705":{"kind":"json-schema","data":{"type":"object","required":["url","expiresAt"],"properties":{"url":{"type":"string","format":"uri","description":"Unique URL to open or embed for the user.","example":"https://wise-sandbox.com/embedded-flows?embeddedLinkRequestId=9f5f5812-2609-4e48-8418-b64437c0c7cd#token=0d0bdc88-bcf4-43dd-85be-7ca65441db20"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp when the returned flow URL expires.","example":"2026-06-15T13:23:20.265Z"}}},"id":"schema_705"},"schema_706":{"kind":"json-schema","data":{"type":"object","required":["redirectUrl","method"],"properties":{"redirectUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected when the flow resolves."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will also include query parameters based on flow completion state and created payment instrument ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/payment-instrument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - Payment Instruments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"example":"https://example.com/return"},"method":{"type":"string","enum":["BACS","SEPA","ACH","EFT"],"description":"The method the payment instrument is created for.","example":"BACS"}}},"id":"schema_706"},"schema_707":{"kind":"json-schema","data":{"type":"object","required":["redirectUrl","kycReviewId"],"properties":{"redirectUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the user will be redirected when the flow resolves."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This will also include query parameters based on flow completion state and completed KYC review ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/embedded-flows/flows/kyc-reviews"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded Flows - KYC Review"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}],"example":"https://example.com/return"},"kycReviewId":{"type":"string","description":"The UUID for the KYC review to be completed.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","format":"uuid"}}},"id":"schema_707"},"schema_708":{"kind":"json-schema","data":{"type":"object","required":["id","profileId","type","clientKey","metadata","redirectUrl"],"properties":{"id":{"type":"string","format":"uuid","description":"Embedded link request ID.","example":"ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198"},"profileId":{"type":"integer","format":"int64","description":"Profile that owns the embedded flow.","example":12345},"type":{"type":"string","description":"Embedded Flow type.","enum":["RECIPIENT","KYC"],"example":"RECIPIENT"},"clientKey":{"type":"string","description":"Client key that created the embedded link request.","example":"partner-client-key"},"metadata":{"type":"object","description":"Flow-specific metadata.","properties":{"targetCurrency":{"type":"string","description":"Optional target currency for hosted recipient creation.","example":"USD"}}},"redirectUrl":{"type":"string","format":"uri","description":"URL where Wise redirects the user after the flow resolves.","example":"https://example.com/return"}}},"id":"schema_708"},"schema_709":{"kind":"json-schema","data":{"type":"object","properties":{"oneTimeTokenProperties":{"$ref":"#/components/schemas/one-time-token"}}},"id":"schema_709"},"schema_710":{"kind":"json-schema","data":{"type":"string","default":"application/jose+json"},"id":"schema_710"},"schema_711":{"kind":"json-schema","data":{"type":"string","default":"identity"},"id":"schema_711"},"schema_712":{"kind":"json-schema","data":{"type":"string","default":"jwe"},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JWE encrypted string. The decrypted payload contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A four-digit string."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload before encryption:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"pin\": \"1234\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"pin\": \"1234\"}\n"},"children":[]}]}]},"id":"schema_713"},"schema_714":{"kind":"json-schema","data":{"type":"object","properties":{"faceMap":{"type":"string","description":"A base64 encoded string."}}},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JWE encrypted string. The decrypted payload contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deviceFingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A string value used as a device fingerprint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload before encryption:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"deviceFingerprint\": \"3207da22-a0d3-4b6b-a591-6297e646fe32\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"deviceFingerprint\": \"3207da22-a0d3-4b6b-a591-6297e646fe32\"}\n"},"children":[]}]}]},"id":"schema_715"},"schema_716":{"kind":"json-schema","data":{"type":"object","properties":{"deviceFingerprintId":{"type":"string","format":"uuid","description":"The identifier of the device fingerprint."},"createdAt":{"type":"string","format":"date-time","description":"The device fingerprint creation timestamp."}}},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JWE encrypted string. The decrypted payload contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deviceFingerprint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A device fingerprint value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload before encryption:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\"deviceFingerprint\": \"3207da22-a0d3-4b6b-a591-6297e646fe32\"}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\"deviceFingerprint\": \"3207da22-a0d3-4b6b-a591-6297e646fe32\"}\n"},"children":[]}]}]},"id":"schema_717"},"schema_718":{"kind":"json-schema","data":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"A valid phone number in string."}}},"id":"schema_718"},"schema_719":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"id":"schema_719"},"schema_720":{"kind":"json-schema","data":{"type":"object","properties":{"obfuscatedPhoneNo":{"type":"string","description":"Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the SMS was sent to.","example":"*********8888"}}},"id":"schema_720"},"schema_721":{"kind":"json-schema","data":{"type":"object","properties":{"otpCode":{"type":"string","description":"6 digit OTP code in text format.","example":"111111"}}},"id":"schema_721"},"schema_722":{"kind":"json-schema","data":{"type":"object","properties":{"obfuscatedPhoneNo":{"type":"string","description":"Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the WhatsApp message was sent to.","example":"*********8888"}}},"id":"schema_722"},"schema_723":{"kind":"json-schema","data":{"type":"object","properties":{"obfuscatedPhoneNo":{"type":"string","description":"Obfuscated phone number that can be used as a hint for the end customer regarding which phone number the voice message was sent to.","example":"*********8888"}}},"id":"schema_723"},"schema_724":{"kind":"json-schema","data":{"type":"object","description":"Request body for creating a balance account.","required":["currency","type"],"properties":{"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"type":{"$ref":"#/components/schemas/BalanceType"},"name":{"type":"string","description":"Name of the balance. Required for SAVINGS type balances."}}},"id":"schema_724"},"schema_725":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}},"id":"schema_725"},"schema_726":{"kind":"json-schema","data":{"type":"object","description":"Request body for balance movements (conversion or transfer).","properties":{"quoteId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote ID. Required for cross-currency movements. Quote must be created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payOut: BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sourceBalanceId":{"type":"integer","format":"int64","description":"Source balance ID. Required when moving between balances (with targetBalanceId)."},"targetBalanceId":{"type":"integer","format":"int64","description":"Target balance ID. Required when moving between balances (with sourceBalanceId)."},"amount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to move. Required for same-currency movements. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quoteId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"properties":{"value":{"type":"number","description":"Amount value."},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code)."}}}}},"id":"schema_726"},"schema_727":{"kind":"json-schema","data":{"type":"object","description":"Response from a balance movement operation.","properties":{"id":{"type":"integer","format":"int64","description":"Movement transaction ID.","example":30000001},"type":{"type":"string","description":"Type of movement.","enum":["DEPOSIT","WITHDRAWAL","CONVERSION"],"example":"CONVERSION"},"state":{"type":"string","description":"State of the movement.","enum":["PENDING","COMPLETED","CANCELLED","REVERSED"],"example":"COMPLETED"},"balancesAfter":{"type":"array","description":"Balance states after the movement.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Balance ID.","example":1},"value":{"type":"number","description":"Balance value after movement.","example":10000594.71},"currency":{"type":"string","description":"Currency code.","example":"GBP"}}}},"creationTime":{"type":"string","format":"date-time","description":"When the movement was created.","example":"2017-11-21T09:55:49.275Z"},"sourceAmount":{"type":"object","description":"Source amount of the movement.","properties":{"value":{"type":"number","example":113.48},"currency":{"type":"string","example":"EUR"}}},"targetAmount":{"type":"object","description":"Target amount of the movement.","properties":{"value":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"rate":{"type":"number","description":"Exchange rate applied to the conversion.","example":0.88558},"feeAmounts":{"type":"array","description":"Fee amounts charged for the movement.","items":{"type":"object","properties":{"value":{"type":"number","example":0.56},"currency":{"type":"string","example":"EUR"}}}},"steps":{"type":"array","description":"Steps involved in the movement.","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Step ID.","example":369588},"type":{"type":"string","description":"Step type.","example":"CONVERSION"},"creationTime":{"type":"string","format":"date-time","description":"When the step was created.","example":"2017-11-21T09:55:49.276Z"},"balancesAfter":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number","example":9998887.01},"currency":{"type":"string","example":"EUR"}}}},"sourceAmount":{"type":"object","properties":{"value":{"type":"number","example":113.48},"currency":{"type":"string","example":"EUR"}}},"targetAmount":{"type":"object","properties":{"value":{"type":"number","example":100},"currency":{"type":"string","example":"GBP"}}},"fee":{"type":"object","properties":{"value":{"type":"number","example":0.56},"currency":{"type":"string","example":"EUR"}}},"rate":{"type":"number","description":"Exchange rate applied.","example":0.88558}}}}}},"id":"schema_727"},"schema_728":{"kind":"json-schema","data":{"type":"object","description":"Deposit limit information for a profile.","properties":{"hasLimit":{"type":"boolean","description":"True if there is a regulatory hold limit for the profile's country.","example":true},"depositLimit":{"type":"object","description":"Amount of money that can be added to the account.","properties":{"amount":{"type":"number","description":"Deposit limit amount.","example":2000},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"SGD"}}}}},"id":"schema_728"},"schema_729":{"kind":"json-schema","data":{"type":"object","description":"Request body for configuring an excess money account.","required":["recipientId"],"properties":{"recipientId":{"type":"integer","format":"int64","description":"ID of the recipient for excess money transfers.","example":148393305}}},"id":"schema_729"},"schema_730":{"kind":"json-schema","data":{"type":"object","description":"Response from configuring an excess money account.","properties":{"userProfileId":{"type":"integer","format":"int64","description":"ID of the profile.","example":12321323},"recipientId":{"type":"integer","format":"int64","description":"ID of the recipient for excess money transfers.","example":148393305}}},"id":"schema_730"},"schema_731":{"kind":"json-schema","data":{"type":"object","description":"Total funds overview for a profile.","properties":{"totalWorth":{"type":"object","description":"Total worth of the account, including cash ledger balance and valuation of any asset portfolio if invested.","properties":{"value":{"type":"number","description":"Amount value.","example":2000},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"totalAvailable":{"type":"object","description":"Total available balance, which is the sum of cash ledger balance and any approved overdraft limit.","properties":{"value":{"type":"number","description":"Amount value.","example":2500},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"totalCash":{"type":"object","description":"Total cash balance across all balances, including group balances but excluding asset portfolios.","properties":{"value":{"type":"number","description":"Amount value.","example":2000},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"overdraft":{"type":"object","description":"Overdraft details for the account.","properties":{"limit":{"type":"object","description":"Maximum overdraft available through an overdraft program. Zero if no approved overdraft.","properties":{"value":{"type":"number","description":"Amount value.","example":500},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"used":{"type":"object","description":"Portion of the approved overdraft limit currently being utilized.","properties":{"value":{"type":"number","description":"Amount value.","example":0},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"available":{"type":"object","description":"Amount of overdraft currently available (limit minus used).","properties":{"value":{"type":"number","description":"Amount value.","example":500},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}},"availableByCurrency":{"type":"array","description":"Available overdraft amounts converted to each currency the customer has a balance in.","items":{"type":"object","properties":{"value":{"type":"number","description":"Amount value.","example":500},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"}}}}}}}},"id":"schema_731"},"schema_732":{"kind":"json-schema","data":{"type":"string","format":"string"},"id":"schema_732"},"schema_733":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/HoldLimitBreach"}},"id":"schema_733"},"schema_734":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/validation for this error type","examples":["/errors/types/validation"]},"title":{"type":"string","description":"Request parameter type mismatch","examples":["Request parameter type mismatch"]},"status":{"type":"string","description":"Bad request error","examples":[400]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/{profileId}/balances/hold-limit-breach?state=INVALID_STATE"]},"errors":{"type":"array","description":"A list of specific validation failures.","items":{"type":"object","properties":{"detail":{"type":"string","description":"A detailed description of the validation failure.","examples":["The parameter value is not of the expected type."]},"code":{"type":"string","description":"A specific code for the validation failure type.","examples":["parameter_invalid_type_mismatch"]},"ref":{"type":"string","description":"A reference to the field that failed validation.","examples":["state","closing_reason"]}}}}}},"id":"schema_734"},"schema_735":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/access for this error type","examples":["/errors/types/access"]},"title":{"type":"string","description":"Forbidden","examples":["Forbidden"]},"status":{"type":"string","description":"Forbidden error","examples":[403]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/{profileId}/balances/hold-limit-breach"]},"detail":{"type":"string","description":"Detail of the error","example":"Unauthorized"},"code":{"type":"string","description":"Error code of the request","example":"forbidden"}}},"id":"schema_735"},"schema_736":{"kind":"json-schema","data":{"type":"object","required":["targetRecipientId","state"],"properties":{"targetRecipientId":{"type":"integer","description":"ID of the recipient to receive the refund of the excess funds.","example":148393305},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is the only supported value."},"children":[]}]}]}],"example":"CLOSED"}}},"id":"schema_736"},"schema_737":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/validation for this error type","examples":["/errors/types/validation"]},"title":{"type":"string","description":"Validation Error","examples":["Validation Error"]},"status":{"type":"string","description":"Bad request error","examples":[400]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/{profileId}/balances/hold-limit-breach?state=INVALID_STATE"]},"errors":{"type":"array","description":"A list of specific validation failures.","items":{"type":"object","properties":{"detail":{"type":"string","description":"A detailed description of the validation failure.","examples":["Only state CLOSED is supported"]},"code":{"type":"string","description":"A specific code for the validation failure type.","examples":["invalid_value"]},"ref":{"type":"string","description":"A reference to the field that failed validation.","examples":["state"]}}}}}},"id":"schema_737"},"schema_738":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/access for this error type","examples":["/errors/types/access"]},"title":{"type":"string","description":"Forbidden","examples":["Forbidden"]},"status":{"type":"string","description":"Forbidden error","examples":[403]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}"]},"detail":{"type":"string","description":"Detail of the error","example":"Hold limit breach {holdLimitBreachId} does not belong to profile {profileId}"},"code":{"type":"string","description":"Error code of the request","example":"forbidden"}}},"id":"schema_738"},"schema_739":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/validation for this error type","examples":["/errors/types/validation"]},"title":{"type":"string","description":"Validation Error","examples":["Validation Error"]},"status":{"type":"string","description":"Validation error","examples":[404]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/{profileId}/balances/hold-limit-breach/{holdLimitBreachId}"]},"detail":{"type":"string","description":"Detail of the error","example":"Hold limit breach not found: 123"},"code":{"type":"string","description":"Error code of the request","example":"not_found"}}},"id":"schema_739"},"schema_740":{"kind":"json-schema","data":{"title":"Balance Update Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-19","3.0.0":"#/components/schemas/v3.0.0","2.2.0":"#/components/schemas/v2.2.0","2.1.0":"#/components/schemas/v2.1.0-2"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-19"},{"$ref":"#/components/schemas/v3.0.0"},{"$ref":"#/components/schemas/v2.2.0"},{"$ref":"#/components/schemas/v2.1.0-2"}]},"id":"schema_740"},"schema_741":{"kind":"json-schema","data":{"title":"Balance Account State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-20","2.0.0":"#/components/schemas/v2.0.0-19"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-20"},{"$ref":"#/components/schemas/v2.0.0-19"}]},"id":"schema_741"},"schema_742":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_742"},"schema_743":{"kind":"json-schema","data":{"type":"string","enum":["COMPACT","FLAT"]},"id":"schema_743"},"schema_744":{"kind":"json-schema","data":{"type":"object","description":"Balance statement containing transactional activities.","properties":{"accountHolder":{"type":"object","description":"Account holder information.","properties":{"type":{"type":"string","description":"Account holder type.","enum":["PERSONAL","BUSINESS"],"example":"PERSONAL"},"address":{"type":"object","description":"Account holder address.","properties":{"addressFirstLine":{"type":"string","description":"Street address.","example":"Veerenni 24"},"city":{"type":"string","description":"City.","example":"Tallinn"},"postCode":{"type":"string","description":"Postal/ZIP code.","example":"12112"},"stateCode":{"type":"string","description":"State code.","example":""},"countryName":{"type":"string","description":"Country name.","example":"Estonia"}}},"firstName":{"type":"string","description":"Account holder first name.","example":"Oliver"},"lastName":{"type":"string","description":"Account holder last name.","example":"Wilson"}}},"issuer":{"type":"object","description":"Account issuer information.","properties":{"name":{"type":"string","description":"Issuer name.","example":"TransferWise Ltd."},"firstLine":{"type":"string","description":"Street address.","example":"56 Shoreditch High Street"},"city":{"type":"string","description":"City.","example":"London"},"postCode":{"type":"string","description":"Postal/ZIP code.","example":"E1 6JJ"},"stateCode":{"type":"string","description":"State code.","example":""},"country":{"type":"string","description":"Country.","example":"United Kingdom"}}},"bankDetails":{"type":["object","null"],"description":"Local bank details for the account."},"transactions":{"type":"array","description":"List of transactions in the statement period.","items":{"type":"object","properties":{"type":{"type":"string","description":"Transaction direction.","enum":["DEBIT","CREDIT"],"example":"DEBIT"},"date":{"type":"string","format":"date-time","description":"Date when transaction was created.","example":"2018-04-30T08:47:05.832Z"},"amount":{"type":"object","description":"Transaction amount.","properties":{"value":{"type":"number","description":"Amount value (negative for debits).","example":-7.76},"currency":{"type":"string","description":"Currency code.","example":"EUR"}}},"totalFees":{"type":"object","description":"Transaction fees.","properties":{"value":{"type":"number","description":"Fee amount.","example":0.04},"currency":{"type":"string","description":"Currency code.","example":"EUR"}}},"details":{"type":"object","description":"Transaction details.","properties":{"type":{"type":"string","description":"Transaction type.","enum":["CARD","CONVERSION","DEPOSIT","TRANSFER","MONEY_ADDED","INCOMING_CROSS_BALANCE","OUTGOING_CROSS_BALANCE","DIRECT_DEBIT","BALANCE_INTEREST","BALANCE_ADJUSTMENT","UNKNOWN","ACCRUAL_CHARGE","INVESTMENT_TRADE_ORDER","ACQUIRING_PAYMENT","CARD_CASHBACK","CARD_ORDER_CHECKOUT"],"example":"CARD"},"description":{"type":"string","description":"Human readable explanation about the transaction.","example":"Card transaction of 6.80 GBP issued by Tfl.gov.uk/cp TFL TRAVEL CH"},"amount":{"type":"object","description":"Amount in original currency (for card transactions abroad).","properties":{"value":{"type":"number","example":6.8},"currency":{"type":"string","example":"GBP"}}},"senderName":{"type":"string","description":"Deposit sender name.","example":"HEIN LAURI"},"senderAccount":{"type":"string","description":"Deposit sender bank account details.","example":"EE76 1700 0170 0049 6704"},"paymentReference":{"type":"string","description":"Deposit payment reference text.","example":"SVWZ+topup card"},"category":{"type":"string","description":"Card transaction category.","example":"Transportation Suburban and Loca"},"merchant":{"type":"object","description":"Card transaction merchant details.","properties":{"name":{"type":"string","description":"Merchant name.","example":"Tfl.gov.uk/cp"},"firstLine":{"type":["string","null"],"description":"Merchant address street."},"postCode":{"type":"string","description":"Merchant address postal code.","example":"SW1H 0TL"},"city":{"type":"string","description":"Merchant address city.","example":"TFL TRAVEL CH"},"state":{"type":"string","description":"Merchant address state.","example":""},"country":{"type":"string","description":"Merchant address country.","example":"GB"},"category":{"type":"string","description":"Merchant category.","example":"Transportation Suburban and Loca"}}},"sourceAmount":{"type":"object","description":"Source amount for conversions.","properties":{"value":{"type":"number","example":8.69},"currency":{"type":"string","example":"GBP"}}},"targetAmount":{"type":"object","description":"Target amount for conversions.","properties":{"value":{"type":"number","example":9.94},"currency":{"type":"string","example":"EUR"}}},"fee":{"type":"object","description":"Conversion fee.","properties":{"value":{"type":"number","example":0.03},"currency":{"type":"string","example":"GBP"}}},"rate":{"type":"number","description":"Conversion exchange rate.","example":1.147806}}},"exchangeDetails":{"type":["object","null"],"description":"Exchange details for card transactions abroad.","properties":{"forAmount":{"type":"object","properties":{"value":{"type":"number","example":6.8},"currency":{"type":"string","example":"GBP"}}},"rate":{"type":["number","null"],"description":"Exchange rate applied."}}},"runningBalance":{"type":"object","description":"Running balance after the transaction.","properties":{"value":{"type":"number","example":16.01},"currency":{"type":"string","example":"EUR"}}},"referenceNumber":{"type":"string","description":"Wise assigned unique transaction reference number. Can be used to map refunds to the original transfer.","example":"CARD-249281"}}}},"endOfStatementBalance":{"type":"object","description":"Closing balance for the specified time period.","properties":{"value":{"type":"number","description":"Balance value.","example":9.94},"currency":{"type":"string","description":"Currency code.","example":"EUR"}}},"query":{"type":"object","description":"Query parameters used for the request.","properties":{"intervalStart":{"type":"string","format":"date-time","description":"Statement start time.","example":"2018-03-01T00:00:00Z"},"intervalEnd":{"type":"string","format":"date-time","description":"Statement end time.","example":"2018-04-30T23:59:59.999Z"},"currency":{"type":"string","description":"Currency code.","example":"EUR"},"accountId":{"type":"integer","format":"int64","description":"Balance account ID.","example":64}}}}},"id":"schema_744"},"schema_745":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":12345678},"id":"schema_745"},"schema_746":{"kind":"json-schema","data":{"type":"object","required":["targetAccountId"],"properties":{"targetAccountId":{"type":"integer","format":"int64","description":"ID of the currency balance to create account details on.","example":123456}}},"id":"schema_746"},"schema_747":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"Account detail ID.","example":"2"},"currency":{"type":"string","description":"Account detail currency (ISO 4217 Alphabetic Code).","example":"GBP"},"active":{"type":"boolean","description":"Status of the account detail.","example":true},"localDetails":{"type":"object","description":"Local bank account details.","properties":{"bankName":{"type":"string","description":"Name of the bank.","example":"Wise"},"bankAddress":{"type":"string","description":"Address of the bank.","example":"TEA BUILDING, FLOOR 6, SHOREDITCH HIGH STREET"},"sortCode":{"type":"string","description":"Sort code of the bank.","example":"231370"},"accountNumber":{"type":"string","description":"Bank account number.","example":"00000001"},"type":{"type":"string","description":"Type of account detail.","example":"UK_ACCOUNT"}}},"internationalDetails":{"type":["object","null"],"description":"International bank account details. Only returned if SWIFT payments are supported for that currency.","properties":{"bankName":{"type":"string","description":"Name of the bank.","example":"Wise"},"bankAddress":{"type":"string","description":"Address of the bank.","example":"TEA BUILDING, FLOOR 6, SHOREDITCH HIGH STREET"},"swiftCode":{"type":"string","description":"Bank SWIFT code.","example":"TRWIGB22XXX"},"iban":{"type":"string","description":"IBAN.","example":"GB123450000000001"},"type":{"type":"string","description":"Type of account detail.","example":"IBAN"}}}}},"id":"schema_747"},"schema_748":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountDetails"}},"id":"schema_748"},"schema_749":{"kind":"json-schema","data":{"type":"object","required":["currency"],"properties":{"currency":{"type":"string","description":"Balance currency (ISO 4217 Alphabetic Code).","example":"EUR"}}},"id":"schema_749"},"schema_750":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Order status.","enum":["PENDING_USER","PENDING_TW","DONE"],"example":"PENDING_USER"},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"requirements":{"type":"array","description":"List of requirements to fulfill the order.","items":{"type":"object","properties":{"type":{"type":"string","description":"Requirement type.","enum":["VERIFICATION","TOP_UP"],"example":"VERIFICATION"},"status":{"type":"string","description":"Requirement status.","enum":["PENDING_USER","PENDING_TW","DONE"],"example":"PENDING_USER"}}}}}},"id":"schema_750"},"schema_751":{"kind":"json-schema","data":{"type":"string","example":"GBP"},"id":"schema_751"},"schema_752":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","description":"Order status.","enum":["PENDING_USER","PENDING_TW","REQUIREMENTS_FULFILLED","DONE"],"example":"DONE"},"currency":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code).","example":"EUR"},"requirements":{"type":"array","description":"List of requirements for the order.","items":{"type":"object","properties":{"type":{"type":"string","description":"Requirement type.","enum":["VERIFICATION","TOP_UP"],"example":"TOP_UP"},"status":{"type":"string","description":"Requirement status.","enum":["PENDING_USER","PENDING_TW","DONE"],"example":"DONE"}}}}}}},"id":"schema_752"},"schema_753":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":987654321},"id":"schema_753"},"schema_754":{"kind":"json-schema","data":{"type":"object","properties":{"reason":{"type":"string","description":"Reason for the return. Required when returning SWIFT payments.\n","enum":["INCORRECT_ACCOUNT_NUMBER","CLOSED_ACCOUNT","BLOCKED_ACCOUNT","CANCELLATION_REQUEST","REGULATORY","CUSTOMER_REQUEST"],"example":"CLOSED_ACCOUNT"}}},"id":"schema_754"},"schema_755":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the return created.","example":"4cc39f2b-3513-453d-8792-9ccc22e513c3"}}},"id":"schema_755"},"schema_756":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Error code.","example":"error.payment-return.invalid"},"message":{"type":"string","description":"Error message.","example":"A valid reason is required to return a Swift payment"},"arguments":{"type":"array","description":"Additional context values related to the error.","items":{},"example":[987654321,123456789,null]}}}}}},"id":"schema_756"},"schema_757":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Error code.","example":"error.payment.not-found"},"message":{"type":"string","description":"Error message.","example":"No payment found with id [123456789] for profile id [987654321]"},"arguments":{"type":"array","description":"Additional context values related to the error.","items":{},"example":[987654321,123456789,null]}}}}}},"id":"schema_757"},"schema_758":{"kind":"json-schema","data":{"title":"Account Details Order State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-5","2.0.0":"#/components/schemas/v2.0.0-5"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-5"},{"$ref":"#/components/schemas/v2.0.0-5"}]},"id":"schema_758"},"schema_759":{"kind":"json-schema","data":{"title":"Account Details Payment State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-6","2.0.0":"#/components/schemas/v2.0.0-6"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-6"},{"$ref":"#/components/schemas/v2.0.0-6"}]},"id":"schema_759"},"schema_760":{"kind":"json-schema","data":{"type":"array","description":"List of currency codes.","items":{"type":"string","description":"3-letter currency code (e.g. EUR, GBP, USD)."}},"id":"schema_760"},"schema_761":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Multi currency account ID.","example":1},"profileId":{"type":"integer","format":"int64","description":"Profile ID the multi currency account is attributed to.","example":33333333},"recipientId":{"type":"integer","format":"int64","description":"Recipient ID of the multi currency account, to be used for transfer recipient.","example":12345678},"creationTime":{"type":"string","format":"date-time","description":"Datetime when multi currency account was created.","example":"2020-05-20T14:43:16.658Z"},"modificationTime":{"type":"string","format":"date-time","description":"Datetime when multi currency account was last modified.","example":"2020-05-20T14:43:16.658Z"},"active":{"type":"boolean","description":"Whether multi currency account is active or not.","example":true},"eligible":{"type":"boolean","description":"Whether multi currency account is eligible or not.","example":true}}},"id":"schema_761"},"schema_762":{"kind":"json-schema","data":{"type":"object","properties":{"eligible":{"type":"boolean","description":"Whether the profile is eligible for a multi currency account.","example":true},"eligibilityCode":{"type":"string","description":"Eligibility status code.","enum":["eligible","invalid.profile.type","invalid.country","invalid.state"],"example":"eligible"},"accountType":{"type":"string","description":"Account type available.","enum":["FULL","RECEIVE_ONLY","INELIGIBLE"],"example":"FULL"},"ineligibilityReason":{"type":["string","null"],"description":"Reason the profile is not eligible.","example":null}}},"id":"schema_762"},"schema_763":{"kind":"json-schema","data":{"type":"string","description":"Unique incoming transfer identifier. UUID-formatted string.","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"id":"schema_763"},"schema_764":{"kind":"json-schema","data":{"title":"Incoming Transfer Credited Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-27"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-27"}]},"id":"schema_764"},"schema_765":{"kind":"json-schema","data":{"type":"integer","format":"int64","minimum":10,"maximum":100,"default":10},"id":"schema_765"},"schema_766":{"kind":"json-schema","data":{"type":"integer","format":"int64","minimum":1,"default":1},"id":"schema_766"},"schema_767":{"kind":"json-schema","data":{"type":"object","properties":{"cards":{"type":"array","description":"Collection of cards for this profile.","items":{"$ref":"#/components/schemas/Card"}},"totalCount":{"type":"integer","format":"int64","description":"The total number of cards for this profile.","example":1}}},"id":"schema_767"},"schema_768":{"kind":"json-schema","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status to update the card to.","enum":["ACTIVE","FROZEN","BLOCKED"],"example":"ACTIVE"}}},"id":"schema_768"},"schema_769":{"kind":"json-schema","data":{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"array","uniqueItems":true,"maxItems":6,"description":"List of permissions to update.","items":{"$ref":"#/components/schemas/Permission"}}}},"id":"schema_769"},"schema_770":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing the invalid permission type.","example":"Permission 'INVALID_TYPE' is not a valid permission type"}}},"id":"schema_770"},"schema_771":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing why the permission update was rejected."}}},"id":"schema_771"},"schema_772":{"kind":"json-schema","data":{"title":"Card Status Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-7","2.0.0":"#/components/schemas/v2.0.0-7"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-7"},{"$ref":"#/components/schemas/v2.0.0-7"}]},"id":"schema_772"},"schema_773":{"kind":"json-schema","data":{"type":"object","properties":{"version":{"type":"integer","format":"int32","description":"Version of the encryption key.","example":1},"key":{"type":"string","description":"The RSA public key.","example":""}}},"id":"schema_773"},"schema_774":{"kind":"json-schema","data":{"type":"object","required":["keyVersion","encryptedPayload"],"properties":{"keyVersion":{"type":"integer","format":"int32","description":"The version of the encryption key to use. Always set to 1.","example":1},"encryptedPayload":{"type":"string","description":"Your JWE encrypted payload.","example":""}}},"id":"schema_774"},"schema_775":{"kind":"json-schema","data":{"type":"object","properties":{"nonce":{"type":"string","format":"uuid","description":"An arbitrary UUID issued from the cryptographic communication.","example":"33d51227-9ad6-4624-b4b7-7853b56076dd"},"cvv2":{"type":"string","description":"The card CVV2 security code.","example":"111"},"pan":{"type":"string","description":"The card Primary Account Number.","example":"4396910000012345"},"expiryDate":{"type":"string","description":"The card expiry date in MM/YY format.","example":"10/31"},"cardholderName":{"type":"string","description":"Name on the card.","example":"John Smith"}}},"id":"schema_775"},"schema_776":{"kind":"json-schema","data":{"type":"object","properties":{"nonce":{"type":"string","format":"uuid","description":"An arbitrary UUID issued from the cryptographic communication.","example":"33d51227-9ad6-4624-b4b7-7853b56076dd"},"pin":{"type":"string","description":"The card PIN.","example":"1234"}}},"id":"schema_776"},"schema_777":{"kind":"json-schema","data":{"type":"object","description":"Request body for setting a card PIN.","required":["keyVersion","encryptedPayload"],"properties":{"keyVersion":{"type":"integer","description":"The version of the key to use. It is always set to 1.","example":1},"encryptedPayload":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/sensitive-card-details"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWE payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"eyJhbGciOiJSU0..."}}},"id":"schema_777"},"schema_778":{"kind":"json-schema","data":{"type":"object","properties":{"cardOrderId":{"type":"string","description":"The card order ID.","example":"142"}}},"id":"schema_778"},"schema_779":{"kind":"json-schema","data":{"title":"3DS Challenge Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-9","2.0.0":"#/components/schemas/v2.0.0-9"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-9"},{"$ref":"#/components/schemas/v2.0.0-9"}]},"id":"schema_779"},"schema_780":{"kind":"json-schema","data":{"type":"object","description":"Request body for producing a card at a kiosk machine.","required":["kioskId"],"properties":{"kioskId":{"type":"string","description":"Identifier that specifies on which kiosk the card should be produced.","example":"WIS00001"}}},"id":"schema_780"},"schema_781":{"kind":"json-schema","data":{"title":"Card Production Status Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-8","2.0.0":"#/components/schemas/v2.0.0-8"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-8"},{"$ref":"#/components/schemas/v2.0.0-8"}]},"id":"schema_781"},"schema_782":{"kind":"json-schema","data":{"type":"object","description":"Request body for creating a card order.","required":["program","cardHolderName"],"properties":{"program":{"type":"string","description":"The name of the card program.","example":"VISA_DEBIT_BUSINESS_UK_1_PHYSICAL_CARDS_API"},"cardHolderName":{"type":"string","description":"The cardholder's name.","example":"John Smith"},"embossedName":{"type":"string","description":"The cardholder's name to print on the card (physical card only). The field length should be between 1 and 22 characters (spaces included).","example":"Smith John"},"phoneNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For partners onboarded after 1/3/2025, we will use the profile phone number for any Card-related One-Time Password (OTP) requests. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/3ds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3ds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure that the phone number is valid and starts with a \"+\" followed by the country code."},"children":[]}]}]}],"example":"+441234567890"},"address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder's billing address or delivery address. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for physical cards. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for virtual cards (defaults to the profile address, if omitted). Fields vary by country. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/card-address-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card address validation guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"firstLine":{"type":"string","example":"56 Shoreditch High St"},"secondLine":{"type":["string","null"],"example":"The Tea Bldg"},"thirdLine":{"type":["string","null"],"example":null},"city":{"type":"string","example":"London"},"postCode":{"type":"string","example":"E1 6JJ"},"state":{"type":["string","null"],"example":null},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"GB"}}},"deliveryOption":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery method for the card order. The delivery method will be defined during scoping phase. Please reach out to your Implementation Manager for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only specify this field for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KIOSK_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not specified, the default delivery method for your region will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL_SERVICE_STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default delivery method. Not traceable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSTAL_SERVICE_WITH_TRACKING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Available in certain regions. Default in Brazil."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KIOSK_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Available in select regions. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-kiosk-collection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"kiosk collection guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["POSTAL_SERVICE_STANDARD","POSTAL_SERVICE_WITH_TRACKING","KIOSK_COLLECTION"],"example":null},"lifetimeLimit":{"type":"number","description":"Optionally sets a lifetime spending limit on the card. A lifetime limit of 0 means that a card cannot be used until the lifetime limit is updated.","example":100},"cardHolderProfileId":{"type":"integer","format":"int64","description":"The cardholder profile for this card. This is used for business profiles.","example":654321},"replacementDetails":{"type":"object","description":"The replacement details for this card.","properties":{"cardToken":{"type":"string","description":"Token of the card to replace.","example":"4a75fdb7-5791-49ac-832c-81c4347e4df0"},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for replacing the card:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_DAMAGED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_EXPIRING"},"children":[]}]}]}]}],"enum":["CARD_DAMAGED","CARD_EXPIRING"],"example":"CARD_DAMAGED"}}}}},"id":"schema_782"},"schema_783":{"kind":"json-schema","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"The total number of card orders for this profile.","example":5},"cardOrders":{"type":"array","items":{"$ref":"#/components/schemas/CardOrder"}}}},"id":"schema_783"},"schema_784":{"kind":"json-schema","data":{"type":"object","properties":{"cardPrograms":{"type":"array","description":"List of available card programs. A Card Program is what Wise refers to all the cards that you will be issuing with us, grouped by product type and by issuing country.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the card program.","example":"VISA_DEBIT_BUSINESS_UK_1_CARDS_API"},"scheme":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The network of the card program:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MASTERCARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISA"},"children":[]}]}]}]}],"enum":["MASTERCARD","VISA"],"example":"VISA"},"defaultCurrency":{"type":"string","description":"The default currency assigned to the card program.","example":"GBP"},"cardType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the card:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIRTUAL_NON_UPGRADEABLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHYSICAL"},"children":[]}]}]}]}],"enum":["VIRTUAL_NON_UPGRADEABLE","PHYSICAL"],"example":"VIRTUAL_NON_UPGRADEABLE"}}}}}},"id":"schema_784"},"schema_785":{"kind":"json-schema","data":{"type":"object","properties":{"requirements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of requirement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set a PIN on the card order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Verify customer by providing KYC evidences"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Provide a valid address for the card order"},"children":[]}]}]}]}],"enum":["PIN","VERIFICATION","ADDRESS"],"example":"PIN"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the requirement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_INITIATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEEDS_ACTION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]}]}],"enum":["NOT_INITIATED","NEEDS_ACTION","PENDING","COMPLETED","FAILED"],"example":"NOT_INITIATED"}}}}}},"id":"schema_785"},"schema_786":{"kind":"json-schema","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The intended new status of the card order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (deprecated)"},"children":[]}]}]}]}],"enum":["CANCELLED","COMPLETED"],"example":"CANCELLED"}}},"id":"schema_786"},"schema_787":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address to validate. Fields vary by country. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/api-guides/card-address-validation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card address validation guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":true,"properties":{"firstLine":{"type":"string","description":"Card holder's address (max 30 characters).","example":"56 Shoreditch High St"},"secondLine":{"type":["string","null"],"description":"Card holder's address (max 30 characters).","example":"The Tea Bldg"},"thirdLine":{"type":["string","null"],"description":"Card holder's address (max 30 characters).","example":null},"city":{"type":"string","description":"Card holder's city (max 30 characters).","example":"London"},"postCode":{"type":"string","description":"Card holder's postal code (max 10 characters).","example":"E1 6JJ"},"state":{"type":["string","null"],"description":"Card holder's state (max 30 characters).","example":null},"country":{"type":"string","description":"Card holder's country (ISO 3166-1 alpha-2, max 2 characters).","example":"GB"}}},"id":"schema_787"},"schema_788":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of validation errors. Empty if address is valid.","items":{"type":"object","properties":{"field":{"type":"string","description":"The field that failed validation.","example":"postCode"},"message":{"type":"string","description":"Description of the validation error.","example":"Please enter a valid postcode"}}}}}},"id":"schema_788"},"schema_789":{"kind":"json-schema","data":{"title":"Card Order Status Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-10","2.0.0":"#/components/schemas/v2.0.0-10"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-10"},{"$ref":"#/components/schemas/v2.0.0-10"}]},"id":"schema_789"},"schema_790":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":10,"maximum":100,"default":20},"id":"schema_790"},"schema_791":{"kind":"json-schema","data":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/CardTransaction"}}}},"id":"schema_791"},"schema_792":{"kind":"json-schema","data":{"title":"Card Transaction State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-11","2.1.0":"#/components/schemas/v2.1.0","2.0.0":"#/components/schemas/v2.0.0-11"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-11"},{"$ref":"#/components/schemas/v2.1.0"},{"$ref":"#/components/schemas/v2.0.0-11"}]},"id":"schema_792"},"schema_793":{"kind":"json-schema","data":{"type":"object","properties":{"spendLimits":{"type":"array","items":{"$ref":"#/components/schemas/profile-limits"}}}},"id":"schema_793"},"schema_794":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["PURCHASE","ATM_WITHDRAWAL"],"description":"The type of transaction."},"aggregateWindow":{"type":"object","properties":{"daily":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent daily.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}},"monthly":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent monthly.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}}}}}},"id":"schema_794"},"schema_795":{"kind":"json-schema","data":{"type":"object","properties":{"transaction":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed per transaction.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}},"daily":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent daily.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}},"monthly":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent monthly.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}},"lifetime":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent over the lifetime of the card.","properties":{"amount":{"type":"number"},"currency":{"type":"string"}}}}}}},"id":"schema_795"},"schema_796":{"kind":"json-schema","data":{"type":"string","enum":["transaction","daily","monthly","lifetime"]},"id":"schema_796"},"schema_797":{"kind":"json-schema","data":{"type":"object","required":["type","aggregateWindow"],"properties":{"type":{"type":"string","description":"The category of spending the limit applies to.","enum":["PURCHASE"]},"aggregateWindow":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limits to set, per aggregation window. At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"daily"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monthly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"properties":{"daily":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent daily.","properties":{"amount":{"type":"number"},"currency":{"minLength":3,"maxLength":3,"type":"string"}}}}},"monthly":{"type":"object","properties":{"value":{"type":"object","description":"The amount allowed to be spent monthly.","properties":{"amount":{"type":"number"},"currency":{"minLength":3,"maxLength":3,"type":"string"}}}}}}}}},"id":"schema_797"},"schema_798":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["MCC","CURRENCY"],"description":"The type of authorisation rule."},"operation":{"type":"string","enum":["ALLOW","BLOCK"],"description":"Determines whether the transactions should be allowed or blocked."},"description":{"type":"string","description":"The description of the authorisation rule."},"values":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of values based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of rule. For example, setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MCC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"1234\", \"5678\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_798"},"schema_799":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/rule"}},"id":"schema_799"},"schema_800":{"kind":"json-schema","data":{"type":"object","properties":{"ruleId":{"type":"string","description":"The ID of the authorisation rule."}}},"id":"schema_800"},"schema_801":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"integer","format":"int64","description":"The ID of the applied authorisation rule."}}}},"id":"schema_801"},"schema_802":{"kind":"json-schema","data":{"type":"object","properties":{"walletNames":{"type":"array","description":"List of supported wallet types.","items":{"type":"string","enum":["APPLE_PAY","GOOGLE_PAY"]},"example":["APPLE_PAY","GOOGLE_PAY"]}}},"id":"schema_802"},"schema_803":{"kind":"json-schema","data":{"type":"object","properties":{"paymentTokens":{"type":"array","items":{"type":"object","title":"Payment Token","properties":{"cardToken":{"type":"string","description":"Card token.","example":"a3f90c98-1cd1-4488-9050-2e32c696f8fa"},"walletName":{"type":"string","description":"Wallet name.","enum":["GOOGLE_PAY","APPLE_PAY"],"example":"GOOGLE_PAY"},"paymentTokenUniqueReference":{"type":"string","description":"Unique reference of the payment token.","example":"DSHRMC0000255389d1106783179b420aa5b5ca09ba2f12b8"},"panUniqueReference":{"type":"string","description":"Unique reference of the PAN.","example":"FSHRMC000025538959679bc73c9d4fdc8031b20fa91d0e3b"},"provisioningStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment token status."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The token is active and available for payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The token has been temporarily suspended"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The token is in the active wallet, but requires additional user authentication for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The status will not be visible, you can safely ignore it"},"children":[]}]}]}]}],"enum":["ACTIVE","SUSPENDED","INACTIVE","DEACTIVATED"],"example":"ACTIVE"},"creationTime":{"type":"string","format":"date-time","description":"Time when the payment token was created.","example":"2025-10-02T21:26:00.377756354Z"},"modificationTime":{"type":"string","format":"date-time","description":"Time when the payment token was last modified.","example":"2025-10-02T21:26:00.378182498Z"}}}}}},"id":"schema_803"},"schema_804":{"kind":"json-schema","data":{"type":"object","required":["activation"],"properties":{"activation":{"type":"string","description":"Approve or decline a payment token activation","enum":["APPROVE","DECLINE"],"example":"APPROVE"}}},"id":"schema_804"},"schema_805":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Validation type error","examples":["/errors/types/validation"]},"title":{"type":"string","description":"A validation type exception","examples":["Validation Error"]},"status":{"type":"string","description":"The HTTP status error code","examples":[400]},"instance":{"type":"string","description":"The uri the triggered a validation error","examples":["/public/v3/spend/profiles/2/cards/f47da127-7b8c-4312-8f10-dd2d70e6912b/payment-tokens/DNI234089950342/activation"]},"errors":{"type":"array","description":"A list of specific validation failures.","items":{"type":"object","properties":{"detail":{"type":"string","description":"A detailed description of the validation failure.","examples":["activation value must be APPROVE or DECLINE"]},"code":{"type":"string","description":"A specific code for the validation failure type.","examples":["invalid_value"]},"ref":{"type":"string","description":"A reference to the field that failed validation.","examples":["activation"]}}}}}},"id":"schema_805"},"schema_806":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"An access type exception","examples":["/errors/types/access"]},"title":{"type":"string","description":"The title of the exception","examples":["Forbidden"]},"status":{"type":"string","description":"The HTTP status error code","examples":[403]},"detail":{"type":"string","description":"A detailed description of the validation failure","examples":["Operation is unauthorized"]},"instance":{"type":"string","description":"The uri the triggered a validation error","examples":["/public/v3/spend/profiles/2/cards/f47da127-7b8c-4312-8f10-dd2d70e6912b/payment-tokens/DNI234089950342/activation"]},"code":{"type":"string","description":"A specific application-level code","examples":["unauthorized"]}}},"id":"schema_806"},"schema_807":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"An domain type exception","examples":["/errors/types/domain"]},"title":{"type":"string","description":"The title of the exception","examples":["Not found"]},"status":{"type":"string","description":"The HTTP status error code","examples":[404]},"detail":{"type":"string","description":"A detailed description of the validation failure","examples":["Payment Token Unique Reference does not exist"]},"instance":{"type":"string","description":"The uri the triggered a validation error","examples":["/public/v3/spend/profiles/2/cards/f47da127-7b8c-4312-8f10-dd2d70e6912b/payment-tokens/DNI234089950342/activation"]},"code":{"type":"string","description":"A specific application-level code","examples":["resource_not_found"]}}},"id":"schema_807"},"schema_808":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":"An server type exception","examples":["/errors/types/server"]},"title":{"type":"string","description":"The title of the exception","examples":["Internal Server Error"]},"status":{"type":"string","description":"The HTTP status error code","examples":[500]},"detail":{"type":"string","description":"A detailed description of the validation failure","examples":["An unexpected error occurred during card tokenisation"]},"instance":{"type":"string","description":"The uri the triggered a validation error","examples":["/public/v3/spend/profiles/2/cards/f47da127-7b8c-4312-8f10-dd2d70e6912b/payment-tokens/DNI234089950342/activation"]}}},"id":"schema_808"},"schema_809":{"kind":"json-schema","data":{"type":"object","required":["clientDeviceId","clientWalletAccountId"],"properties":{"clientDeviceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable device identification set by Wallet Provider. Could be computer identifier or ID tied to hardware such as TEE_ID or SE_ID. This field must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientDeviceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wallet provider will send in token provision request."},"children":[]}]}]}],"example":"ed6abb56323ba656521ac476"},"clientWalletAccountId":{"type":"string","description":"Client-provided consumer ID that identifies the Wallet Account Holder entity.","example":"walletid"}}},"id":"schema_809"},"schema_810":{"kind":"json-schema","data":{"type":"object","properties":{"opaquePaymentCard":{"type":"string","description":"Encrypted authentication and activation data following card scheme and wallet provider specifications. The response is encoded in Base64.","example":"eyJraWQiOiIwQk..."},"cardNetwork":{"type":"string","description":"Card network.","enum":["CARD_NETWORK_VISA","CARD_NETWORK_MASTERCARD"],"example":"CARD_NETWORK_VISA"},"tokenServiceProvider":{"type":"string","description":"Token service provider.","enum":["TOKEN_PROVIDER_VISA","TOKEN_PROVIDER_MASTERCARD"],"example":"TOKEN_PROVIDER_VISA"},"cardDisplayName":{"type":"string","description":"Default card name that will be displayed in wallet.","example":"Wise Card"},"cardLastDigits":{"type":"string","description":"Last 4 digits of the card PAN.","example":"1234"},"userAddress":{"type":"object","description":"Entire address and phone number associated with the card.","properties":{"addressLine1":{"type":"string","description":"First line of the address.","example":"56 Shoreditch High St"},"addressLine2":{"type":"string","description":"Second line of the address.","example":"The Tea Bldg"},"countryCode":{"type":"string","description":"Country code.","example":"GB"},"locality":{"type":"string","description":"City or locality.","example":"London"},"administrativeArea":{"type":"string","description":"State or administrative area.","example":""},"name":{"type":"string","description":"Cardholder name.","example":"John Smith"},"phoneNumber":{"type":"string","description":"Phone number associated with the card.","example":"+441234567890"},"postalCode":{"type":"string","description":"Postal code.","example":"E1 6JJ"}}}}},"id":"schema_810"},"schema_811":{"kind":"json-schema","data":{"type":"object","required":["certificates","nonce","nonceSignature"],"properties":{"certificates":{"type":"array","description":"DER encoded X.509 ECC leaf and sub CA certificates, each encoded in Base64.","items":{"type":"string"},"example":["MIICpTCCAkqgAwIBAgIIB...","MIICpTCCAYmgAwIBAgIIX..."]},"nonce":{"type":"string","description":"One time use nonce generated by Apple Servers and HEX encoded on iOS app.","example":"a1b2c3d4e5f6"},"nonceSignature":{"type":"string","description":"The device and account specific signature of the nonce generated by Apple and HEX encoded on iOS app.","example":"f6e5d4c3b2a1"}}},"id":"schema_811"},"schema_812":{"kind":"json-schema","data":{"type":"object","properties":{"encryptedPassData":{"type":"string","description":"Encrypted authentication data following card scheme and wallet provider specifications. The response is encoded in Base64.","example":"443232323637393045DDE321469537FE461E824AA55BA67BF645454330A32433610DE1D1461475BEB6D815F31764DDC20298BD779FBE37EE5AB3CBDA9F9825E1"},"activationData":{"type":"string","description":"Encrypted activation data following card scheme and wallet provider specifications. The response is encoded in Base64.","example":"KDlTthhZTGufMY…….xPSUrfmqCHXaI9wOGY="},"ephemeralKey":{"type":"string","description":"Ephemeral key used to encrypt authentication data. The response is encoded in Base64.","example":"A1B2C3D4E5F6112233445566"}}},"id":"schema_812"},"schema_813":{"kind":"json-schema","data":{"type":"string","enum":["MASTERCARD","VISA"]},"id":"schema_813"},"schema_814":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","description":"Email used to receive communications regarding the dispute from Wise (e.g. your support team's email).","example":"support@partner.com"}}},"id":"schema_814"},"schema_815":{"kind":"json-schema","data":{"type":"object","description":"Dynamic Flow JSON object. Pass this to the Dynamic Flow framework to render the dispute form."},"id":"schema_815"},"schema_816":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DisputeReason"}},"id":"schema_816"},"schema_817":{"kind":"json-schema","data":{"type":"object","properties":{"transaction":{"type":"object","description":"Transaction details for the dispute.","properties":{"transactionId":{"type":"string","description":"ID of the transaction.","example":"12345"},"email":{"type":"string","description":"Email of the support team that Wise should reach out to.","example":"support@partner.com"}}},"form":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Form fields required to submit this dispute. The specific fields vary per reason code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/product/issue-cards/card-disputes-api#reason-examples"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disputes via API guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for per-reason field details."},"children":[]}]}]}],"additionalProperties":true},"disclaimer":{"type":"object","description":"Acknowledgement fields.","properties":{"allAnswered":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acknowledgment that all questions have been answered. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the request will be rejected."},"children":[]}]}]}],"example":true},"filesUploaded":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acknowledgment that all relevant files have been attached. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the request will be rejected."},"children":[]}]}]}],"example":true}}},"files":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key-value pairs mapping file field names to file IDs obtained from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/disputes/disputefileupload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"file upload endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Available file fields vary per reason code."},"children":[]}]}]}],"additionalProperties":{"type":"string"}}}},"id":"schema_817"},"schema_818":{"kind":"json-schema","data":{"type":"object","description":"Dynamic Flow JSON object."},"id":"schema_818"},"schema_819":{"kind":"json-schema","data":{"type":"object","properties":{"receipt":{"type":"string","format":"binary","description":"The file to upload."}}},"id":"schema_819"},"schema_820":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"},"description":"Object with the file field name as key and the assigned file ID as value."},"id":"schema_820"},"schema_821":{"kind":"json-schema","data":{"type":"string","enum":["ACTIVE","CLOSED"]},"id":"schema_821"},"schema_822":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":10,"maximum":100,"default":10},"id":"schema_822"},"schema_823":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"default":1},"id":"schema_823"},"schema_824":{"kind":"json-schema","data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of disputes matching the filters.","example":2},"disputes":{"type":"array","items":{"$ref":"#/components/schemas/Dispute"}}}},"id":"schema_824"},"schema_825":{"kind":"json-schema","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CLOSED"],"example":"CLOSED"}}},"id":"schema_825"},"schema_826":{"kind":"json-schema","data":{"title":"Transaction Disputes Update Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-25","2.0.0":"#/components/schemas/v2.0.0-22"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-25"},{"$ref":"#/components/schemas/v2.0.0-22"}]},"id":"schema_826"},"schema_827":{"kind":"json-schema","data":{"type":"object","required":["sourceCurrency","targetCurrency"],"properties":{"sourceCurrency":{"type":"string","description":"Source (sending) currency code.","example":"GBP"},"targetCurrency":{"type":"string","description":"Target (receiving) currency code.","example":"USD"},"sourceAmount":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in source currency. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, never both."},"children":[]}]}]}],"example":null},"targetAmount":{"type":["number","null"],"description":"Amount in target currency.","example":110},"pricingConfiguration":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when configured for your client ID. Includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be used for pricing calculations with the quote."},"children":[]}]}]}],"properties":{"fee":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of fee to be configured. Options include only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".\""},"children":[]}]}]}],"example":"OVERRIDE"},"variable":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected variable percentage, in decimal format, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.011},"fixed":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected fixed fee that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always considered in source currency."},"children":[]}]}]}],"example":15.42}}}}}}},"id":"schema_827"},"schema_828":{"kind":"json-schema","data":{"type":"object","required":["sourceCurrency","targetCurrency"],"properties":{"sourceCurrency":{"type":"string","description":"Source (sending) currency code.","example":"GBP"},"targetCurrency":{"type":"string","description":"Target (receiving) currency code.","example":"USD"},"sourceAmount":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount in source currency. Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, never both."},"children":[]}]}]}],"example":100},"targetAmount":{"type":["number","null"],"description":"Amount in target currency.","example":null},"targetAccount":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is the ID of transfer recipient, found in the create recipient response. If provided, can be used as an alternative to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/quote/quoteupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updating the quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":12345},"payOut":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Preferred payout method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of other accepted values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT_OUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALIPAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERAC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":null},"preferredPayIn":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Preferred payin method. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return this method at the top of the response's results."},"children":[]}]}]}],"example":null},"paymentMetadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used to pass additional metadata about the intended transfer."},"children":[]}]}]}],"properties":{"transferNature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used to pass transfer nature for calculating proper tax amounts (IOF) for transfers to and from BRL. Accepted values are shown dynamically in transfer requirements."},"children":[]}]}]}],"example":"MOVING_MONEY_BETWEEN_OWN_ACCOUNTS"}}},"pricingConfiguration":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when configured for your client ID. Includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be used for pricing calculations with the quote."},"children":[]}]}]}],"properties":{"fee":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of fee to be configured. Options include only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"OVERRIDE"},"variable":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected variable percentage, in decimal format, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.011},"fixed":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected fixed fee that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always considered in source currency."},"children":[]}]}]}],"example":15.42}}}}}}},"id":"schema_828"},"schema_829":{"kind":"json-schema","data":{"type":"object","properties":{"targetAccount":{"type":"integer","format":"int64","description":"ID of transfer recipient, found in the create recipient response.","example":12345},"payOut":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Preferred payout method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of other accepted values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT_OUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALIPAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERAC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SWIFT_OUR"},"paymentMetadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used to pass additional metadata about the intended transfer."},"children":[]}]}]}],"properties":{"transferNature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Used to pass transfer nature for calculating proper tax amounts (IOF) for transfers to and from BRL. Accepted values are shown dynamically in transfer requirements."},"children":[]}]}]}],"example":"MOVING_MONEY_BETWEEN_OWN_ACCOUNTS"}}},"pricingConfiguration":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when configured for your client ID. Includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be used for pricing calculations with the quote. If previously passed, the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remain and not be updated."},"children":[]}]}]}],"properties":{"fee":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of fee to be configured. Options include only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OVERRIDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"OVERRIDE"},"variable":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected variable percentage, in decimal format, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.011},"fixed":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected fixed fee, in source currency, that should be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricingConfiguration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":15.42}}}}}}},"id":"schema_829"},"schema_830":{"kind":"json-schema","data":{"type":"string","enum":["day","hour","minute"]},"id":"schema_830"},"schema_831":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","description":"The resulting Rate object.","required":["rate","source","target","time"],"properties":{"rate":{"type":"number","format":"double","description":"Exchange rate value.","example":1.166},"source":{"type":"string","description":"Source (send) currency code.","example":"EUR"},"target":{"type":"string","description":"Target (receive) currency code.","example":"USD"},"time":{"type":"string","description":"Timestamp for exchange rate.","example":"2018-08-31T10:43:31+0000"}}}},"id":"schema_831"},"schema_832":{"kind":"json-schema","data":{"type":"number"},"id":"schema_832"},"schema_833":{"kind":"json-schema","data":{"type":"string","enum":["POPULAR"]},"id":"schema_833"},"schema_834":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["bank","moneytransferprovider","travelMoney"]}},"id":"schema_834"},"schema_835":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_835"},"schema_836":{"kind":"json-schema","data":{"type":"integer","format":"int32","maximum":20},"id":"schema_836"},"schema_837":{"kind":"json-schema","data":{"type":["integer","null"],"format":"int64"},"id":"schema_837"},"schema_838":{"kind":"json-schema","data":{"type":"string","example":"id,asc"},"id":"schema_838"},"schema_839":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","description":"List of recipient accounts returned for this page.","items":{"$ref":"#/components/schemas/recipient"}},"seekPositionForNext":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seek position for the next page of the response. For pagination, use this value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seekPosition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter of your next request to fetch the next page."},"children":[]}]}]}]},"seekPositionForCurrent":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seek position for the current page of the response. For pagination, use this value for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seekPosition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter of your next request to fetch this current page again."},"children":[]}]}]}]},"sort":{"type":"object","description":"Sort metadata.","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}},"size":{"type":"integer","format":"int32","description":"Page size returned.","example":20}}},"id":"schema_839"},"schema_840":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_840"},"schema_841":{"kind":"json-schema","data":{"type":"object","description":"Recipient creation validation error response.","properties":{"timestamp":{"type":"string","description":"Timestamp of occurrence (ISO-8601 timestamp).","example":"2024-12-06T06:43:52.472471344Z"},"errors":{"type":"array","description":"List of validation errors.","items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"NOT_VALID"},"message":{"type":"string","description":"Human-readable error message.","example":"Unknown bank code. Please check the sort code is correct, or contact customer support for more information."},"path":{"type":"string","description":"Field associated with the error.","example":"sortCode"},"arguments":{"type":"array","description":"Field with error as well as input value.","items":{"type":"string"},"example":["sortCode","231479"]}}}}}},"id":"schema_841"},"schema_842":{"kind":"json-schema","data":{"type":"string","enum":["BUSINESS","PRIVATE"]},"id":"schema_842"},"schema_843":{"kind":"json-schema","data":{"type":"integer","enum":[1]},"id":"schema_843"},"schema_844":{"kind":"json-schema","data":{"type":"object","properties":{"accountId":{"type":"integer","format":"int64","description":"Recipient account ID.","example":40000000},"quoteId":{"type":"string","description":"Quote ID.","example":"00000000-0000-0000-0000-000000000000"},"confirmations":{"$ref":"#/components/schemas/confirmations"}}},"id":"schema_844"},"schema_845":{"kind":"json-schema","data":{"type":"object","required":["acceptedOutcomes"],"properties":{"acceptedOutcomes":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the customer accepted the confirmation outcome."},"children":[]}]}]}],"example":true}}},"id":"schema_845"},"schema_846":{"kind":"json-schema","data":{"title":"Recipient State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-28"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-28"}]},"id":"schema_846"},"schema_847":{"kind":"json-schema","data":{"type":"object","properties":{"identifier":{"type":"string","description":"A Wise profile's identifier. It can be a Wisetag, email or phone number."},"targetCurrency":{"type":"string","description":"3 character currency code."}}},"id":"schema_847"},"schema_848":{"kind":"json-schema","data":{"type":"object","properties":{"contactId":{"type":"string","format":"uuid","description":"Contact ID in the format of UUID."},"name":{"type":"string","description":"Full name of the contact."}}},"id":"schema_848"},"schema_849":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/transfer"},{"$ref":"#/components/schemas/originator-transfer"}]},"id":"schema_849"},"schema_850":{"kind":"json-schema","data":{"type":"object","required":["targetAccount","quoteUuid"],"properties":{"targetAccount":{"type":"integer","format":"int64","description":"Recipient account ID"},"quoteUuid":{"type":"string","format":"uuid","description":"V2 quote ID"},"customerTransactionId":{"type":"string","format":"uuid","description":"Unique identifier for the transfer request"},"originatorLegalEntityType":{"type":"string","enum":["PRIVATE","BUSINESS"],"description":"Type of sender. Required from March 2026 for Correspondent Send integrations"},"details":{"type":"object","properties":{"reference":{"type":"string"},"sourceOfFunds":{"type":"string"},"sourceOfFundsOther":{"type":"string"},"transferPurpose":{"type":"string"},"transferPurposeSubTransferPurpose":{"type":"string"},"transferPurposeInvoiceNumber":{"type":"string"},"transferNature":{"type":"string"}}}}},"id":"schema_850"},"schema_851":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/transfer-requirement"}},"id":"schema_851"},"schema_852":{"kind":"json-schema","data":{"type":"integer","description":"Profile Id","format":"int64","example":123456789},"id":"schema_852"},"schema_853":{"kind":"json-schema","data":{"type":"integer","description":"Transfer Id","format":"int64","example":16521632},"id":"schema_853"},"schema_854":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/payment"}},"id":"schema_854"},"schema_855":{"kind":"json-schema","data":{"type":"object","properties":{"processorName":{"type":"string","description":"The legal entity that processed the transfer on behalf of the customer","example":"Acme Bank Ltd."},"deliveryMode":{"type":"string","description":"The delivery mode for the payment (e.g. SWIFT)","example":"SWIFT"},"bankingPartnerReference":{"type":"string","description":"The reference used by the partner bank to identify and track the transfer","example":"ABCD1234"},"bankingPartnerName":{"type":"string","description":"The name of the sending bank to the recipient's bank","example":"Global Bank Corp."},"mt103":{"type":["string","null"],"description":"The MT103 of the transfer, if available"}}},"id":"schema_855"},"schema_856":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_856"},"schema_857":{"kind":"json-schema","data":{"title":"Transfer Active Cases Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0","2.0.0":"#/components/schemas/v2.0.0"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0"},{"$ref":"#/components/schemas/v2.0.0"}]},"id":"schema_857"},"schema_858":{"kind":"json-schema","data":{"title":"Transfer Refund Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-2","2.0.0":"#/components/schemas/v2.0.0-2"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-2"},{"$ref":"#/components/schemas/v2.0.0-2"}]},"id":"schema_858"},"schema_859":{"kind":"json-schema","data":{"title":"Transfer Payout Failure Event","discriminator":{"propertyName":"schema_version","mapping":{"5.0.0":"#/components/schemas/v5.0.0","4.0.0":"#/components/schemas/v4.0.0-3","2.0.0":"#/components/schemas/v2.0.0-3"}},"oneOf":[{"$ref":"#/components/schemas/v5.0.0"},{"$ref":"#/components/schemas/v4.0.0-3"},{"$ref":"#/components/schemas/v2.0.0-3"}]},"id":"schema_859"},"schema_860":{"kind":"json-schema","data":{"title":"Transfer State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-4","2.0.0":"#/components/schemas/v2.0.0-4"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-4"},{"$ref":"#/components/schemas/v2.0.0-4"}]},"id":"schema_860"},"schema_861":{"kind":"json-schema","data":{"type":"object","required":["targetAccount","quoteUuid","customerTransactionId"],"properties":{"sourceAccount":{"type":"integer","format":"int64","description":"Refund recipient account ID"},"targetAccount":{"type":"integer","format":"int64","description":"Recipient account ID. You can create multiple transfers to same recipient account"},"quoteUuid":{"type":"string","format":"uuid","description":"V2 quote ID. You can only create one transfer per one quote. You cannot use same quote ID to create multiple transfers"},"customerTransactionId":{"type":"string","format":"uuid","description":"Required to perform idempotency check to avoid duplicate transfers in case of network failures or timeouts"},"details":{"type":"object","properties":{"reference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient will see this reference text in their bank statement. Maximum allowed characters depends on the currency route. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://wise.com/help/articles/2932870/tips-for-paying-invoices"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Payments Tips"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a full list"},"children":[]}]}]}]},"transferPurpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditionally required. For example when target currency is THB. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferrequirementsvalidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for conditions"},"children":[]}]}]}]},"transferPurposeSubTransferPurpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditionally required. For example when target currency is CNY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferrequirementsvalidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for conditions"},"children":[]}]}]}]},"transferPurposeInvoiceNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditionally required. For example when target currency is INR. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferrequirementsvalidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for conditions"},"children":[]}]}]}]},"sourceOfFunds":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conditionally required. For example when target currency is USD and transfer amount exceeds 80k. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer/transferrequirementsvalidate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for conditions"},"children":[]}]}]}]}}}}},"id":"schema_861"},"schema_862":{"kind":"json-schema","data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/transfer"},{"$ref":"#/components/schemas/originator-transfer"}]}},"id":"schema_862"},"schema_863":{"kind":"json-schema","data":{"type":"integer","description":"The profile ID.","format":"int64","example":123456789},"id":"schema_863"},"schema_864":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Path to the created transfer","example":"/public/v2/profiles/123/third-party-transfers/16521632"},"X-External-Correlation-Id":{"type":"string","format":"uuid","maxLength":36,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoed back when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-External-Correlation-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was included in the request. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer/headers/correlation-id"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"x-trace-id":{"type":"string","description":"Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.","example":"fba501b6d453b96789f52338f019341f"}}},"id":"schema_864"},"schema_865":{"kind":"json-schema","data":{"type":"object","properties":{"estimatedDeliveryDate":{"type":"string","format":"date-time","description":"Estimated time when funds will arrive in the recipient's bank account."},"formattedEstimatedDeliveryDate":{"type":"string","description":"A string to display to users for the estimated delivery date."}}},"id":"schema_865"},"schema_866":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Currency code (ISO 4217 Alphabetic Code)."},"symbol":{"type":"string","description":"The symbol of this currency."},"name":{"type":"string","description":"Display name of this currency."},"countryKeywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with this currency."},"supportsDecimals":{"type":"boolean","description":"Whether this currency supports decimal values or not."}}}},"id":"schema_866"},"schema_867":{"kind":"json-schema","data":{"type":"object","required":["sourceCurrency","name"],"properties":{"sourceCurrency":{"type":"string","description":"Source currency code (ISO 4217 Alphabetic Code). This currency is expected to be used for funding the batch group.","example":"GBP"},"name":{"type":"string","description":"Descriptive name for display purposes. Recommended to use a name that uniquely represents this batch. Maximum length of 100 characters.","example":"My batch group"}}},"id":"schema_867"},"schema_868":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"id":"schema_868"},"schema_869":{"kind":"json-schema","data":{"type":"object","required":["status","version"],"properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status to update to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Close the group and allow funding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Cancel the group and all transfers"},"children":[]}]}]}]}],"enum":["COMPLETED","CANCELLED"],"example":"COMPLETED"},"version":{"type":"integer","format":"int64","description":"The expected batch group version for concurrency control. Must match the server's current version.","example":1234}}},"id":"schema_869"},"schema_870":{"kind":"json-schema","data":{"type":"object","required":["targetAccount","quoteUuid","customerTransactionId"],"properties":{"targetAccount":{"type":"integer","format":"int64","description":"Recipient account ID.","example":67890},"sourceAccount":{"type":"integer","format":"int64","description":"Refund recipient account ID.","example":12345},"quoteUuid":{"type":"string","format":"uuid","description":"Quote ID.","example":"bd244a95-dcf8-4c31-aac8-bf5e2f3e54c0"},"customerTransactionId":{"type":"string","format":"uuid","description":"Unique identifier you generate for this transfer attempt.","example":"a]1b2c3d4-e5f6-7890-abcd-ef1234567890"},"details":{"type":"object","properties":{"reference":{"type":"string","description":"Recipient-facing reference (payment narrative).","example":"to my friend"},"transferPurpose":{"type":"string","description":"Transfer purpose code.","example":"verification.transfers.purpose.pay.bills"},"transferPurposeSubTransferPurpose":{"type":"string","description":"Sub-purpose code for the transfer.","example":"verification.sub.transfers.purpose.pay.interpretation.service"},"sourceOfFunds":{"type":"string","description":"Source of funds code.","example":"verification.source.of.funds.other"}}}}},"id":"schema_870"},"schema_871":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer object. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/transfer#object"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer API reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full details."},"children":[]}]}]}]},"id":"schema_871"},"schema_872":{"kind":"json-schema","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The method of payment to use.","enum":["BALANCE"],"example":"BALANCE"}}},"id":"schema_872"},"schema_873":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique batch group ID.","example":"54a6bc09-cef9-49a8-9041-f1f0c654cd88"},"name":{"type":"string","description":"Descriptive name.","example":"My batch group"},"fileName":{"type":["string","null"],"description":"If this batch was submitted as a file, this is the given file name.","example":null},"alreadyPaid":{"type":"boolean","description":"Not applicable to this use case.","example":true},"shortId":{"type":"integer","format":"int64","description":"Not applicable to this use case.","example":12345},"userId":{"type":"integer","format":"int64","description":"The ID of the user who initiated this payment.","example":33333333},"profileId":{"type":"integer","format":"int64","description":"The ID of the profile this payment belongs to.","example":44444444},"sourceCurrency":{"type":"string","description":"The source currency of the batch. Note that if there are insufficient funds, an automatic conversion from another currency can occur.","example":"GBP"},"status":{"type":"string","description":"Current batch group status.","enum":["NEW","COMPLETED","MARKED_FOR_CANCELLATION","PROCESSING_CANCEL","CANCELLED"],"example":"COMPLETED"},"groupType":{"type":"string","description":"Whether this batch was submitted over the API or as a file.","enum":["API","FILE"],"example":"API"},"transferIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The IDs of all transfers in the group.","example":[100001,100002,100003]}}},"id":"schema_873"},"schema_874":{"kind":"json-schema","data":{"type":"object","required":["type","accountId"],"properties":{"type":{"type":"string","description":"The method of payment to use.","enum":["DIRECT_DEBIT"],"example":"DIRECT_DEBIT"},"accountId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct debit account ID. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/direct-debit-account/directdebitaccountcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct debit account creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"reference":{"type":"string","description":"Optional payment initiation reference. Maximum 10 characters. If not provided, a reference will be generated automatically.","example":"B1234567"}}},"id":"schema_874"},"schema_875":{"kind":"json-schema","data":{"type":"integer","format":"int64","example":12345},"id":"schema_875"},"schema_876":{"kind":"json-schema","data":{"title":"Batch Payment Initiations State Change Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-21","2.0.0":"#/components/schemas/v2.0.0-20"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-21"},{"$ref":"#/components/schemas/v2.0.0-20"}]},"id":"schema_876"},"schema_877":{"kind":"json-schema","data":{"type":"object","properties":{"payinBank":{"type":"object","description":"Information about the receiving bank.","properties":{"bankName":{"type":"string","description":"Bank name.","example":"Wise Europe SA/NV"},"bankAddress":{"type":["object","null"],"description":"Bank address.","properties":{"country":{"type":"string","description":"Country ISO 2 code.","example":"BE"},"firstLine":{"type":"string","description":"Street address.","example":"Rue Du Trône 100, box 3"},"postCode":{"type":"string","description":"Post code / zip code.","example":"1050"},"city":{"type":"string","description":"City.","example":"Brussels"},"state":{"type":["string","null"],"description":"State.","example":null},"phone":{"type":["string","null"],"description":"Phone number.","example":"+32 472 123 456"}}}}},"payinBankAccount":{"type":"object","description":"Bank account details to use to send the payment to.","properties":{"currency":{"type":"string","description":"ISO 4217 source currency code.","example":"EUR"},"bankAccountType":{"type":"string","description":"The type of bank account to use for the payin, e.g. RECIPIENT, ESCROW, BALANCE, etc.","example":"RECIPIENT"},"details":{"type":"array","description":"Account details.","items":{"type":"object","description":"Account detail entry.","properties":{"type":{"type":"string","description":"Account details type, e.g. accountNumber, iban etc.","example":"iban"},"label":{"type":"string","description":"Account details label that should be displayed in your user interface.","example":"IBAN"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account details value. This field is deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rawValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"formattedValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":"BE11111111111111","deprecated":true},"rawValue":{"type":"string","description":"Account details value, always unformatted. Can be used for processing.","example":"BE11111111111111"},"formattedValue":{"type":["string","null"],"description":"Account details value, formatted according to the type of the field. Intended to be human-readable. This can be null.","example":"BE11 1111 1111 1111"},"description":{"type":"string","description":"Description of the account detail type.","example":"International Bank Account Number"}}}}}},"wiseInformation":{"type":"object","description":"Information about the receiving Wise entity, the owner of the bank account.","properties":{"localCompanyName":{"type":"string","description":"Wise local company name.","example":"Wise Europe SA"},"localAddress":{"type":["object","null"],"description":"Wise local address.","properties":{"country":{"type":"string","description":"Country ISO 2 code.","example":"BE"},"firstLine":{"type":"string","description":"Street address.","example":"Rue du Trône 100, 3rd floor"},"postCode":{"type":"string","description":"Post code / zip code.","example":"1050"},"city":{"type":"string","description":"City.","example":"Brussels"},"state":{"type":["string","null"],"description":"State.","example":null},"phone":{"type":["string","null"],"description":"Phone number.","example":null}}}}}}},"id":"schema_877"},"schema_878":{"kind":"json-schema","data":{"type":"object","properties":{"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the bank account. 3-character currency code — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for ACH direct debits, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for EFT direct debits."},"children":[]}]}]}],"example":"USD"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type for which the account is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — US direct debit (USD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — CA direct debit (CAD)"},"children":[]}]}]}]}],"enum":["ACH","EFT"],"example":"ACH"},"details":{"type":"object","description":"Bank account details.","properties":{"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid ABA routing number. For CAD direct debits, the routing number is a combination of an institution number + transit number."},"children":[]}]}]}],"example":"000000000"},"accountNumber":{"type":"string","description":"A valid bank account number.","example":"0000000000"},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account type."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHECKING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Checking account (USD, CAD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVINGS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Savings account (USD, CAD)"},"children":[]}]}]}]}],"enum":["CHECKING","SAVINGS"],"example":"CHECKING"}}}}},"id":"schema_878"},"schema_879":{"kind":"json-schema","data":{"type":"string","enum":["ACH","EFT"]},"id":"schema_879"},"schema_880":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/DirectDebitAccount"}},"id":"schema_880"},"schema_881":{"kind":"json-schema","data":{"type":"object","required":["type","settlementReference","settlementDate","transfers"],"properties":{"type":{"type":"string","description":"Type of settlement.","enum":["TRUSTED_BULK_SETTLEMENT"],"example":"TRUSTED_BULK_SETTLEMENT"},"settlementReference":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference used when paying the end of day settlement monies to Wise. This should match so that Wise can link the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 10 characters, must start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TPFB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix."},"children":[]}]}]}],"pattern":"^TPFB.{1,6}$","example":"TPFB190322"},"settlementDate":{"type":"string","format":"date-time","description":"The date you send the settlement funds, ISO 8601 format.","example":"2019-03-22T23:59:59-05:00"},"settlementCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency in which the transfers in this journal will be settled. If included, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set on every transfer in the transfers array."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only include if you will settle in a currency different to the source currency of transfers."},"children":[]}]}]}]}],"example":"USD"},"transfers":{"type":"array","description":"Array of transfers to be settled.","items":{"type":"object","required":["id","date","sourceAmount","sourceCurrency","customerName","partnerReference"],"properties":{"id":{"type":"integer","format":"int64","description":"ID of the transfer to be settled.","example":125678},"date":{"type":"string","format":"date-time","description":"The date the transfer was created, ISO 8601 format.","example":"2019-03-22T10:00:12-05:00"},"sourceAmount":{"type":"number","format":"decimal","description":"Transfer source amount with fee, always positive.","example":23.24},"sourceCurrency":{"type":"string","description":"Transfer source currency (ISO 4217).","example":"USD"},"customerName":{"type":"string","description":"Name of the customer. Helps identify customer when manual operation is required.","example":"Joe Bloggs"},"partnerReference":{"type":"string","description":"The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.","example":"11111"},"comment":{"type":"string","description":"Other data about the transfer or sender.\n\nFor USA, you should send the account refund information for the sending customer (account number, routing number, street address, etc.)\n","example":"Extra Data"},"exchangeRate":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exchange rate you used to calculate the settlement amount for this transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set on the journal."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can set this value to be unique per transfer or the same for every transfer, depending on your settlement approach and agreements with Wise."},"children":[]}]}]}],"example":0.875469}}}},"refundedTransfers":{"type":"array","description":"Array of transfers for which refunds have been processed. Only for Net Settlement.","items":{"type":"object","required":["id","partnerReference"],"properties":{"id":{"type":"integer","format":"int64","description":"ID of the refunded transfer.","example":178880},"exchangeRate":{"type":"number","format":"decimal","description":"The exchange rate used for this transfer. Should be the same value as the one used for the original transfer settlement.","example":0.875469},"partnerReference":{"type":"string","description":"The transaction/payment identifier in your system, uniquely identifies the transfer in your platform.","example":"11108"}}}},"balanceTransfer":{"type":"number","format":"decimal","description":"The amount of money to be deducted from the expected settlement amount based on what is owed to you for previous days where the total settlement from you to Wise was negative.\n\nThis value must be 0 or negative.\n","example":0}}},"id":"schema_881"},"schema_882":{"kind":"json-schema","data":{"title":"Bulk Settlement Payment Received Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-26","3.0.0":"#/components/schemas/v3.0.0-3","2.0.0":"#/components/schemas/v2.0.0-23"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-26"},{"$ref":"#/components/schemas/v3.0.0-3"},{"$ref":"#/components/schemas/v2.0.0-23"}]},"id":"schema_882"},"schema_883":{"kind":"json-schema","data":{"type":"object","properties":{"qrCodeInBase64":{"type":"string","description":"An encoded QR image in base64 format, which can be decoded and displayed directly to the end user.","example":"iVBORw0KGgoAAAANSUhEUgAAAXUAAAF1CAIAAACYn+2fAAB2CUlEQVR4Xux9B2BU15k1cYxAdJCQhB..."},"details":{"type":"object","description":"Manual input details that can be used by the end user to make the transfer without scanning the QR image.","properties":{"virtualPaymentAddress":{"type":"string","description":"Virtual payment address to pay to.","example":"UEN123456789R#WISE"},"amount":{"type":["number"],"description":"Transfer amount.","example":100},"currency":{"type":["string"],"description":"Currency.","example":"SGD"},"reference":{"type":["string"],"description":"Payment reference used for linking the PayNow transaction to the transfer created by the profile.","example":"PP12345678"},"entityName":{"type":["string"],"description":"Entity name of the Wise Account to make the PayNow transfer to.","example":"WISE ASIA-PACIFIC PTE LTD"}}}}},"id":"schema_883"},"schema_884":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/validation for this error type.","examples":["/errors/types/validation"]},"title":{"type":"string","description":"Validation Error","examples":["Validation Error"]},"status":{"type":"string","description":"Bad Format Validation Error","examples":[400]},"instance":{"type":"string","description":"The uri the triggered a validation error","examples":["/v1/profiles/12345678/payin-sessions/74a3fe63-f37e-49ff-f744-8ef020efabcde/paynow"]},"errors":{"type":"array","description":"A list of specific validation failures.","items":{"type":"object","properties":{"detail":{"type":"string","description":"A detailed description of the validation failure.","examples":["Invalid request to create payment for session 1."]},"code":{"type":"string","description":"A specific code for the validation failure type.","examples":["invalid_request"]},"ref":{"type":"string","description":"A reference to the field that failed validation."}}}}}},"id":"schema_884"},"schema_885":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"Must be /errors/types/domain for this error type.","examples":["/errors/types/domain"]},"title":{"type":"string","description":"Unprocessable Entity","examples":["Unprocessable Entity"]},"status":{"type":"string","description":"Unprocessable Entity Domain Error","examples":[422]},"instance":{"type":"string","description":"The uri that triggered the error","examples":["/v1/profiles/12345678/payin-sessions/74a3fe63-f37e-49ff-f744-8ef020efabcde/paynow"]},"code":{"type":"string","description":"Error code of the request","example":"payins.paynow.details.creation.not.allowed"}}},"id":"schema_885"},"schema_886":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/subscription"}},"id":"schema_886"},"schema_887":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/test-notification"}},"id":"schema_887"},"schema_888":{"kind":"json-schema","data":{"title":"Partner Support Case Changed Event","discriminator":{"propertyName":"schema_version","mapping":{"5.0.0":"#/components/schemas/v5.0.0-3","4.0.0":"#/components/schemas/v4.0.0-22","2.0.0":"#/components/schemas/v2.0.0-21"}},"oneOf":[{"$ref":"#/components/schemas/v5.0.0-3"},{"$ref":"#/components/schemas/v4.0.0-22"},{"$ref":"#/components/schemas/v2.0.0-21"}]},"id":"schema_888"},"schema_889":{"kind":"json-schema","data":{"title":"Swift In Credit Event","discriminator":{"propertyName":"schema_version","mapping":{"4.3.0":"#/components/schemas/v4.3.0","4.2.0":"#/components/schemas/v4.2.0","4.1.0":"#/components/schemas/v4.1.0","4.0.0":"#/components/schemas/v4.0.0-23","3.0.0":"#/components/schemas/v3.0.0-2"}},"oneOf":[{"$ref":"#/components/schemas/v4.3.0"},{"$ref":"#/components/schemas/v4.2.0"},{"$ref":"#/components/schemas/v4.1.0"},{"$ref":"#/components/schemas/v4.0.0-23"},{"$ref":"#/components/schemas/v3.0.0-2"}]},"id":"schema_889"},"schema_890":{"kind":"json-schema","data":{"title":"Swift Message Received Event","discriminator":{"propertyName":"schema_version","mapping":{"4.0.0":"#/components/schemas/v4.0.0-24"}},"oneOf":[{"$ref":"#/components/schemas/v4.0.0-24"}]},"id":"schema_890"},"schema_891":{"kind":"json-schema","data":{"type":"string","enum":["processing","funds_converted","outgoing_payment_sent","bounced_back","funds_refunded"]},"id":"schema_891"},"schema_892":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"properties":{"failure_reason_code":{"type":"string","description":"Failure reason code to trigger for payout failure. When not provided, a failure code is selected at random and returned."}}},"id":"schema_892"},"schema_893":{"kind":"json-schema","data":{"type":"object","required":["profileId","balanceId","currency","amount"],"properties":{"profileId":{"type":"integer","format":"int64","description":"The profile ID linked to the balance account."},"balanceId":{"type":"integer","format":"int64","description":"The ID of the balance account that is going to receive the funds."},"currency":{"type":"string","description":"The currency to top up the balance account in. Must be the same currency as the balance account."},"amount":{"type":"number","description":"The amount to top up the balance account with."},"channel":{"type":"string","enum":["TRANSFER","CARD"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of top-up. Not providing a channel will default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_893"},"schema_894":{"kind":"json-schema","data":{"type":"object","properties":{"transactionId":{"type":"integer","format":"int64","description":"The ID of the top-up transaction."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always returned when using this endpoint."},"children":[]}]}]}]},"balancesAfter":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The ID of the balance account."},"value":{"type":"number","description":"The new amount available in the balance account."},"currency":{"type":"string","description":"The currency of the balance account."}}}}}},"id":"schema_894"},"schema_895":{"kind":"json-schema","data":{"type":"object","properties":{"pos":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The point-of-sale used for the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For POS transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHIP_AND_PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For e-commerce transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E_COMMERCE_NO_3DS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ATM transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHIP_AND_PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For refund transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHIP_AND_PIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E_COMMERCE_NO_3DS"},"children":[]}]}]}]}]},"transactionType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For POS and e-commerce transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOODS_AND_SERVICES"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ATM transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For refund transactions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]}]}]}]}]},"amount":{"type":"object","properties":{"value":{"type":"number","description":"Transaction amount."},"currency":{"type":"string","description":"Currency code."}}},"mcc":{"type":"integer","format":"int32","description":"Merchant category code."},"cardNumber":{"type":"string","description":"Primary Account Number of the card."}}},"id":"schema_895"},"schema_896":{"kind":"json-schema","data":{"type":"object","properties":{"reference":{"type":"object","description":"The transaction reference. This can be used in a following request for reversal and clearing."},"error":{"type":["string","null"],"description":"An error returned by the transaction, if it exists."}}},"id":"schema_896"},"schema_897":{"kind":"json-schema","data":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"number","description":"Transaction amount."},"currency":{"type":"string","description":"Currency code."}}},"transactionType":{"type":"string","description":"The type of the transaction. Use the same transaction type from the previous authorisation request."},"ref":{"type":"object","description":"The transaction reference. This can be obtained from a previous authorisation request."}}},"id":"schema_897"},"schema_898":{"kind":"json-schema","data":{"type":"object","properties":{"reference":{"type":"object","description":"The transaction reference."},"error":{"type":["string","null"],"description":"An error returned by the transaction, if it exists."}}},"id":"schema_898"},"schema_899":{"kind":"json-schema","data":{"type":"object","properties":{"amount":{"type":"object","properties":{"value":{"type":"number","description":"Transaction amount. Set to 0 for full reversal, or the intended final value for partial reversal."},"currency":{"type":"string","description":"Currency code."}}},"transactionType":{"type":"string","description":"The type of the transaction. Use the same transaction type from the previous authorisation request."},"ref":{"type":"object","description":"The transaction reference. This can be obtained from a previous authorisation request."}}},"id":"schema_899"},"schema_900":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":10},"id":"schema_900"},"schema_901":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"integer","format":"int64","description":"ID of the transaction."},"creationTime":{"type":"number","description":"Time when the card transaction was created."}}}},"id":"schema_901"},"schema_902":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["PRODUCED","PRODUCTION_ERROR"],"description":"The intended production status of the card."},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/card-kiosk-collection/cardkioskcollectionproduce"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to simulate. This field should be set only if the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCTION_ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_902"},"schema_903":{"kind":"json-schema","data":{"type":"object","properties":{"requirements":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"KYC review item key."},"state":{"type":"string","enum":["NOT_PROVIDED","IN_REVIEW","VERIFIED","REJECTED"],"description":"State of the KYC review item."},"description":{"type":["string","null"],"description":"Description of the KYC review item."}}}}}},"id":"schema_903"},"schema_904":{"kind":"json-schema","data":{"type":"object","properties":{"requestedAction":{"type":"string","enum":["APPROVE","REJECT"],"description":"The action to be carried out."},"requirement":{"type":"string","description":"Requirement to simulate hosted journey for."}}},"id":"schema_904"},"schema_905":{"kind":"json-schema","data":{"type":"object","properties":{"requirement":{"type":"string","description":"Requirement to simulate hosted journey for."}}},"id":"schema_905"},"schema_906":{"kind":"json-schema","data":{"type":"object","properties":{"requestedAction":{"type":"string","enum":["APPROVE","REJECT"],"description":"The action to be carried out."},"requirements":{"type":"array","items":{"type":"string"},"description":"Zero or more requirements to be verified. If not provided, all blocking requirements are verified."}}},"id":"schema_906"},"schema_907":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the case. Value must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERAL_ENQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". More case types will be added in the future."},"children":[]}]}]}],"example":"GENERAL_ENQUIRY"},"subject":{"type":"string","description":"The subject of the case. Do not include PII in the subject of cases.","example":"Inquiry about Transfer 12345"},"details":{"type":"object","description":"Details related to the case.","properties":{"transferId":{"type":["integer","null"],"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the transfer the case relates to. Can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":58114690},"profileId":{"type":["integer","null"],"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the profile the case relates to. Can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":14556049},"userId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the user the case relates to. Can not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1234}}},"externalId":{"type":"string","description":"An ID provided by the external partner for partner internal tracking.","example":"partner_external_id_12345"},"description":{"type":"string","description":"The description of the request. The maximum size of the description is 65,535 characters. If additional characters are sent, the field will be truncated.","example":"Initial summary of the issue"}}},"id":"schema_907"}},"exampleStore":{"paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example":{"value":{"version":1,"keyMaterial":{"algorithm":"ES512","keyMaterial":"MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBYAwVICxD0Paq7MOuO34omujHxSrQXZtiTQ/VMteqAeUfM4wE+vTSpbYCqb1pNhhcQpF+FJd2H8jB1H1zil7qLLcBw+yl4PrnLza1pmNLr+kqQVoVXVyVx/xxMK2WObLn8tHxXtW4k+bm1/ySF+0RQ265IZcw2i8YYX2FY59JkwE2Fac="},"scope":"PAYLOAD_SIGNING"},"id":"paths/~1auth~1jose~1response~1public-keys/get/responses/200/content/application~1json/example"},"paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example":{"value":{"keyId":"e87da464-8e5e-4380-8f2d-4e4e04052672","scope":"PAYLOAD_SIGNING","validFrom":"2023-04-27 00:00:00","validTill":"2024-04-01 00:00:00","publicKeyMaterial":{"algorithm":"ES512","keyMaterial":"MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBYAwVICxD0Paq7MOuO34omujHxSrQXZtiTQ/VMteqAeUfM4wE+vTSpbYCqb1pNhhcQpF+FJd2H8jB1H1zil7qLLcBw+yl4PrnLza1pmNLr+kqQVoVXVyVx/xxMK2WObLn8tHxXtW4k+bm1/ySF+0RQ265IZcw2i8YYX2FY59JkwE2Fac="}},"id":"paths/~1auth~1jose~1request~1public-keys/post/requestBody/content/application~1json/example"},"paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example":{"value":{"clientId":null,"keyId":"e87da464-8e5e-4380-8f2d-4e4e04052672","scope":"PAYLOAD_SIGNING","validFrom":"2023-04-27 00:00:00","validTill":"2024-04-01 00:00:00","publicKeyMaterial":{"algorithm":"ES512","keyMaterial":"MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBYAwVICxD0Paq7MOuO34omujHxSrQXZtiTQ/VMteqAeUfM4wE+vTSpbYCqb1pNhhcQpF+FJd2H8jB1H1zil7qLLcBw+yl4PrnLza1pmNLr+kqQVoVXVyVx/xxMK2WObLn8tHxXtW4k+bm1/ySF+0RQ265IZcw2i8YYX2FY59JkwE2Fac="},"deactivationTimestamp":null},"id":"paths/~1auth~1jose~1request~1public-keys/post/responses/201/content/application~1json/example"},"paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example":{"value":"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsInVybCI6Ii92MS9hdXRoL2pvc2UvcGxheWdyb3VuZC9qd3MifQ.eyJtZXNzYWdlIjoiVGhpcyBpcyBhbiBleGFtcGxlIGZyb20gZG9jcy53aXNlLmNvbSJ9.AS9QHdkWvUEn0LxQEMPRBzlceN78J-Le-Qm1XIkkSBpsGdc0WM0MZTIGFEAJEcWeUR2M-abtd5DRdar4hLzs9apPAQ-GT70SIDV6pX9-4UKfIfzJ4g305zCoHflTfn-ijvI7XrVR_yr7xO9GJo86bfBqAX_m5uuxyU7Jy9gM1epd8HcC","id":"paths/~1auth~1jose~1playground~1jws/post/requestBody/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example":{"value":"eyJ2ZXJzaW9uIjoxLCJhbGciOiJFUzUxMiJ9.eyJtZXNzYWdlIjoiam9zZS1wbGF5Z3JvdW5kLXJlc3BvbnNlLVRoaXMgaXMgYW4gZXhhbXBsZSBmcm9tIGRvY3Mud2lzZS5jb20iLCJtZXRob2QiOiJQT1NUIn0.APYfoUySW_dPdBBVST3tJdaCBCMQZm0UR6g0vBqxjjX4WWkOdt6h045EXZKMT1m0JEMI5b7KpN14Mib9BxS7VWpLAPwYhTU5pJcQrtiK4fwaBMTT_DwipZk6ASXVevrMK_Tn9YSSkKDsv6X9qyBsnIXKy304Ex5QIHKmSGQT6wNSJ7Ye02","id":"paths/~1auth~1jose~1playground~1jws/post/responses/200/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example":{"value":"eyJraWQiOiI2ZGE0OTQ5NS0xNjMyLTQzY2QtOWEwMy1kZDMyNDYwM2VjZDciLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.UC5mC6XSGZZuQzUALpM2QfDWyi-lcl4Wv3v8-9L04BFmqYTyiQMO-YMxiwzOdVbF-L01CaFcr_iuoM36fKp01onJAtsrvuGcnrHeh23kMwZ5k29ycGTckE0YYLe-WV9WtXguudfFC3Hri9v4FTPEE1_BbkrHACVufuhw_xWUWgYAekfm7dnmTI_3SmtExWZ_P-Xn6rkGXhsJ0Kq9LB-F3mnuvz_iglvZsW76RdLV_I4es-TfTnQgVOGO-N38SSS4wCF1qw2TWOkpNAe9kyAg6a8tWw8ZkpOxJlmGdp4jLuG_GDWlmtDrv9ntgeCLDRiTp4SLYL2MGYdmNXigZI5xrg.P_h3CuIiKxEzndER.Zf0wahZEHQSMcb4olkeT1NNzh3Alj34XbXVdREiqQH9CKDa-GnKvh1lXXYuvTO99vtBmNRM.iTzGQ3FNRIybDT_lJcnaeQ03","id":"paths/~1auth~1jose~1playground~1jwe/get/responses/200/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example":{"value":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W_WPBDXclMryaywqAB-_yC1hUYukKmZxByhE9d1G8hClc2HpewkryILGJW4uVTUeRdo1oVWd68TPIqi7bqMGUsrT-3MI4ggVSjC1rf8Lf1xTZ8-GHjSPso8tFBXnydOKzggi6fnfk98BIW76Rnxkn6sW79LH5NgN1spTOoh8-tI3i_wbHdqJOxTReaUNMYZobm7wxedZcRxhsaSrVqx2qdELeqkfwgvB1DRbHTF_PTe4W0ibMbcJivHjiDf6oAV9vXgVhYb66rhB43pgdFDv4nY1mkQC45R5T6CBdzv80EdAVOj1G4bktHyJWaJzHVsGozpxsNj3bt1AopyvDO8tsw.WLOO5WH4ZpBPi-8B.0g3eUpQPvRIaTbgUi6sH0WejsJ1nLWDGnDKTktZrkquLQlCMmIguj0I5UCyqXEo.URtTniRvfGxrKRLK63trug","id":"paths/~1auth~1jose~1playground~1jwe/post/requestBody/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example":{"value":"eyJraWQiOiI2ZGE0OTQ5NS0xNjMyLTQzY2QtOWEwMy1kZDMyNDYwM2VjZDciLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.qwMqgFXRI84THQdCHhxNe5yvKOuKp2rAMH62xQ1OioPatnLfxqPHJUX0as13B3g3JKaqGgF0qMi7r3QbJ_cXNFBIg1yenCwWv4192J73-kEkCSyS-FflDCNfih1z1mm95ftAE7FhHJVG5tcSm_B0-bPU3SbjB3SDhR3QlLX5o_sQmYkQay8PKSssyBS5tCjuKdz-9QNvZtNADPujKrJGe5hE5r7ShcNwVUS2vpMXANiQTzZnQ2L3j_m07Rru-PgMxHTD2uR621B87YfTHonWDJe4XogA_pMWD_hzHVQKT7Il--2YOtv8PTnLge-uVvRTgqUiYUdvq85nPyDKsOQMnQ.zprknKK9W4iAX7YA.LJWA6oRcYj0LruM3GLPtZ0CtVNpI0Zs9WFrARDd464kKxSlu15LBiFFCFwOHbeKoRudfp8Br7MfRIlaTLHxPEE1xoBB8jZN8fakAcApU.OlMATtfF9XMtYJtTsGuBGQ02","id":"paths/~1auth~1jose~1playground~1jwe/post/responses/200/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example":{"value":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.rVqOhX92u637hqwrw96rqA48e7NhMZVeWvUZwA4OAwOa_sBVcpXecd6qivPfZ-CuhRaD4gNKUlUJnTedBwOh5hcDZELRWThtwNiTZKaDS_ZNDjJf1r0VQPj65nT2ikfPAP-S6cYCy6JbWXivf7Jwq6lus-QydmxoLlVRvAuROFe-HzlH0-JhlwOdhPwbwl1AGx64qEir7oOn5VezJvpx3sscipm3w30mfoFc7pLlscMijMNFUwngXCLmgpno1rC_ZDzRcEycVbwvgKW75jO25UyEJif25MdE0UJUx4IT6MDviHqtBXO4OQpwhd_W6jVk-PlZ1WkZyOZqpi8HLKGo8Q.eFHqPV-mcBC82Ga2.W9o2BT7Q-vEUA2u3n4gaSdfQY_4svVj0-jwjcXmlBraZEKmtTW_A1ygvr8b9iHfS9fkxL8H_6S_oEcqzFqTKmNTzwe2V0cRY-kvzsKI.lO2gETmo2WocPZoTpU-pkQ","id":"paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/requestBody/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example":{"value":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..gTnxA4uYrCTWVNp1.jQ3dDidM2Z8RuYkgQt1ydJ6xYy5uG3CH72-pioHlZPqucxPWeN1pWwmceQKgpGulJmw3nYLRNkgCa9yQHMofpFIlV5HQJS6mQDxZP4G2kj3bFKvByckRYQQ3v3W7TkjfVL4NAVlrDqxx3G29-qblRwbyneMP.mVY_uctEfEAleVVbHjcqdA04","id":"paths/~1auth~1jose~1playground~1jwe-direct-encryption/post/responses/200/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example":{"value":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.W0fuxaZOoyaBcxWwgtjEPkOnLdVNyH9ncZi5Y9xQbjD4sYJn8vEQmxKHDw5s14sWhdexSNAPTVMSyzwJaA-LRL0tZTEuQ.ohD4LLjImiKOV4Tu.Rgp9mc2JD6m9Zm5htSqrejwWYy0_hIylYdLD39ZCR-VnQ2VX-Tot8kKGeNncnv7hJ_ApANWiJpKJbiM.5hNt-uaxuOkOraGGZSmsig","id":"paths/~1auth~1jose~1playground~1jwsjwe/post/requestBody/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example":{"value":"eyJraWQiOiJiMzc0ODE1MC0xNGQ0LTRlMDAtYjM5NC03YWUwYzkzYmUyNDUiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.VGhpcyBpcyB0aGUgZW5jcnlwdGVkIENFSw.aXZfdmFsdWU.ZW5jcnlwdGVkX3BheWxvYWQ.YXV0aF90YWc","id":"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/200/content/application~1jose+json/example"},"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError":{"value":{"error":"jws_error","error_description":"Unable to verify the request signature"},"key":"jwsError","summary":"Unable to verify request signature","id":"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/400/content/application~1json/examples/jwsError"},"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"message":"An unexpected error occurred","request_id":"c29beb2374156c390c06fb583e99c999"},"key":"unexpectedError","summary":"Unexpected server error","id":"paths/~1auth~1jose~1playground~1jwsjwe/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example":{"value":{"id":12345,"name":null,"email":"new.user@domain.com","active":true,"details":null},"id":"paths/~1user~1signup~1registration_code/post/responses/200/content/application~1json/example"},"paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example":{"value":{"errors":[{"code":"NOT_UNIQUE","message":"You're already a member. Please login","path":"email","arguments":["email","class com.transferwise.fx.api.ApiRegisterCommand","existing.user@domain.com"]}]},"id":"paths/~1user~1signup~1registration_code/post/responses/409/content/application~1json/example"},"paths/~1users~1exists/post/responses/200/content/application~1json/example":{"value":{"exists":true},"id":"paths/~1users~1exists/post/responses/200/content/application~1json/example"},"paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example":{"value":{"email":"new-user@email.com"},"id":"paths/~1users~1{userId}~1contact-email/put/responses/200/content/application~1json/example"},"paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example":{"value":{"email":"new-user@email.com"},"id":"paths/~1users~1{userId}~1contact-email/get/responses/200/content/application~1json/example"},"paths/~1user~1claim-account/post/requestBody/content/application~1json/example":{"value":{"registrationCode":""},"id":"paths/~1user~1claim-account/post/requestBody/content/application~1json/example"},"paths/~1user~1claim-account/post/responses/200/content/application~1json/example":{"value":{"claimAccountCode":""},"id":"paths/~1user~1claim-account/post/responses/200/content/application~1json/example"},"paths/~1profiles/get/responses/200/content/application~1json/example":{"value":[{"type":"PERSONAL","id":14575282,"publicId":"a1b2c3d4-e5f6-7890-1234-567890abcdef","userId":9889627,"address":{"id":36086782,"addressFirstLine":"24 Willow Creek Lane","city":"Bristol","countryIso2Code":"GB","countryIso3Code":"gbr","postCode":"BS1 6AE","stateCode":null},"email":"sarah.jenkins@example.com","createdAt":"2023-01-15T10:30:00","updatedAt":"2025-06-18T14:20:00","avatar":"https://example.com/avatars/sarah_jenkins.png","currentState":"VISIBLE","contactDetails":{"email":"sarah.contact@example.com","phoneNumber":"+447700900123"},"firstName":"Sarah","lastName":"Jenkins","preferredName":"Sal","dateOfBirth":"1985-05-20","phoneNumber":"+447700900456","secondaryAddresses":[],"fullName":"Sarah Jenkins"},{"type":"BUSINESS","id":14599371,"publicId":"f0e9d8c7-b6a5-4321-fedc-ba9876543210","userId":9889627,"address":{"id":36152772,"addressFirstLine":"15 Tech Hub Studios","city":"Manchester","countryIso2Code":"GB","countryIso3Code":"gbr","postCode":"M1 7JA","stateCode":null},"email":"info@innovate-solutions.co.uk","createdAt":"2024-03-10T09:00:00","updatedAt":"2025-06-18T14:22:00","contactDetails":{"email":"contact@innovate-solutions.co.uk","phoneNumber":"+441617891234"},"businessName":"Innovate Solutions Ltd","registrationNumber":"SC1234567890ABCD","descriptionOfBusiness":"IT_DEVELOPMENT","webpage":"https://www.innovate-solutions.co.uk","companyType":"LIMITED_COMPANY","businessFreeFormDescription":"We create cutting-edge software for businesses.","firstLevelCategory":"CONSULTING_IT_BUSINESS_SERVICES","secondLevelCategory":"IT_DEVELOPMENT","industryCategories":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"],"operationalAddresses":[{"id":36152773,"addressFirstLine":"Unit 5, Innovation Park","city":"Leeds","countryIso2Code":"GB","countryIso3Code":"gbr","postCode":"LS1 4YZ","stateCode":null}],"fullName":"Innovate Solutions Ltd"}],"id":"paths/~1profiles/get/responses/200/content/application~1json/example"},"paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails":{"value":{"businessName":"ABC Logistics Ltd","businessNameInKatakana":null,"businessFreeFormDescription":"Biz free form desc","registrationNumber":"12144939","acn":null,"abn":null,"arbn":null,"companyType":"LIMITED","companyRole":"OWNER","address":{"addressFirstLine":"1 A road","city":"London","countryIso2Code":"gb","countryIso3Code":"gbr","postCode":"11111"},"externalCustomerId":"67890-biz-acct","actorEmail":"biz-acct@abcl.com","industryCategories":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"],"operationalAddresses":[{"addressFirstLine":"1 A road","city":"London","countryIso2Code":"gb","countryIso3Code":"gbr","postCode":"11111"}],"webpage":"https://abc-logistics.com","businessRepresentative":{"firstName":"Oliver","lastName":"Wilson","preferredName":"Olivia","address":{"addressFirstLine":"50 Sunflower Ave","city":"Phoenix","countryIso3Code":"usa","postCode":"10025","stateCode":"AZ"},"dateOfBirth":"1977-07-01","contactDetails":{"email":"o.wilson@example.com","phoneNumber":"+3725064992"}}},"key":"withRepresentativeDetails","summary":"With Business Representative details","id":"paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeDetails"},"paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId":{"value":{"businessName":"ABC Logistics Ltd","businessNameInKatakana":null,"businessFreeFormDescription":"Biz free form desc","registrationNumber":"12144939","acn":null,"abn":null,"arbn":null,"companyType":"LIMITED","companyRole":"OWNER","address":{"addressFirstLine":"1 A road","city":"London","countryIso2Code":"gb","countryIso3Code":"gbr","postCode":"11111"},"externalCustomerId":"67890-biz-acct","actorEmail":"biz-acct@abcl.com","industryCategories":["SOFTWARE_DEVELOPMENT_PUBLISHING","IT_CONSULTANCY_TECHNICAL_SUPPORT_SERVICES"],"operationalAddresses":[{"addressFirstLine":"1 A road","city":"London","countryIso2Code":"gb","countryIso3Code":"gbr","postCode":"11111"}],"webpage":"https://abc-logistics.com","businessRepresentative":{"businessRepresentativeId":123}},"key":"withRepresentativeId","summary":"With Business Representative ID","id":"paths/~1profiles~1business-profile/post/requestBody/content/application~1json/examples/withRepresentativeId"},"paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails":{"value":{"updateContext":"UPDATE_DETAILS","contactDetails":{"email":"o.wilson@example.com","phoneNumber":"+3725064992"}},"key":"updateDetails","summary":"Update Details","id":"paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/updateDetails"},"paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation":{"value":{"updateContext":"TRANSFER_OF_AUTHORISATION","firstName":"Oliver","lastName":"Wilson","preferredName":"Olivia","address":{"addressFirstLine":"50 Sunflower Ave","city":"Phoenix","countryIso3Code":"usa","postCode":"10025","stateCode":"AZ"},"dateOfBirth":"1977-07-01","contactDetails":{"email":"o.wilson@example.com","phoneNumber":"+3725064992"}},"key":"transferOfAuthorisation","summary":"Transfer of Authorisation","id":"paths/~1profiles~1{profileId}~1business-profile~1business-representative/put/requestBody/content/application~1json/examples/transferOfAuthorisation"},"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard":{"value":{"firstName":"Oliver","lastName":"Wilson","type":"IDENTITY_CARD","uniqueIdentifier":"AA299822313","issueDate":"2017-12-31","issuerCountry":"EE","issuerState":"","expiryDate":"2027-12-31"},"key":"identityCard","summary":"Identity Card","id":"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/identityCard"},"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj":{"value":{"type":"CPF_CNPJ","uniqueIdentifier":"938.936.652-69"},"key":"cpfCnpj","summary":"CPF or CNPJ","id":"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/cpfCnpj"},"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr":{"value":{"type":"FINANCIAL_CAPACITY_BR","uniqueIdentifier":"150000.00"},"key":"financialCapacityBr","summary":"Financial Capacity Brazil","id":"paths/~1profiles~1{profileId}~1verification-documents/post/requestBody/content/application~1json/examples/financialCapacityBr"},"paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard":{"value":{"clientId":"mercury","firstName":"Oliver","lastName":"Wilson","type":"IDENTITY_CARD","uniqueIdentifier":"AA299822313","issueDate":"2017-12-31","issuerCountry":"EE","issuerState":"","expiryDate":"2027-12-31","nationality":"GB","sex":"MALE"},"key":"identityCard","summary":"Update Identity Card","id":"paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/identityCard"},"paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence":{"value":{"clientId":"mercury","firstName":"Oliver","lastName":"Wilson","type":"DRIVERS_LICENCE","uniqueIdentifier":"DL12345","issueDate":"2020-01-15","issuerCountry":"US","issuerState":"NY","expiryDate":"2028-01-15"},"key":"driversLicence","summary":"Update Drivers Licence","id":"paths/~1profiles~1{profileId}~1verification-documents/put/requestBody/content/application~1json/examples/driversLicence"},"paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example":{"value":[{"firstName":"John","lastName":"Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa"},{"firstName":"Jane","lastName":"Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa"}],"id":"paths/~1profiles~1{profileId}~1directors/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example":{"value":[{"id":10,"firstName":"John","lastName":"Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa"},{"id":11,"firstName":"Jane","lastName":"Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa"}],"id":"paths/~1profiles~1{profileId}~1directors/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example":{"value":[{"id":10,"firstName":"John","lastName":"Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa"},{"id":11,"firstName":"Jane","lastName":"Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa"}],"id":"paths/~1profiles~1{profileId}~1directors/get/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example":{"value":[{"firstName":"John","lastName":"Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa"},{"firstName":"Jane","lastName":"Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa"}],"id":"paths/~1profiles~1{profileId}~1directors/put/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example":{"value":[{"id":14,"firstName":"John","lastName":"Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa"},{"id":15,"firstName":"Jane","lastName":"Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa"}],"id":"paths/~1profiles~1{profileId}~1directors/put/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners":{"value":[{"name":"John Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa","addressFirstLine":"123 Fake St","postCode":"FK 12345","ownershipPercentage":30},{"name":"Jane Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa","addressFirstLine":"125 Fake St","postCode":"FK 12545","ownershipPercentage":70}],"key":"twoOwners","summary":"Two beneficial owners (30/70 split)","id":"paths/~1profiles~1{profileId}~1ubos/post/requestBody/content/application~1json/examples/twoOwners"},"paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example":{"value":[{"id":"013ab1c2688d0185b582ee7e0bcb28b2","name":"John Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa","addressFirstLine":"123 Fake St","postCode":"FK 12345","ownershipPercentage":30},{"id":"912ce3f31c8b3a10572137e78417caa3","name":"Jane Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa","addressFirstLine":"125 Fake St","postCode":"FK 12545","ownershipPercentage":70}],"id":"paths/~1profiles~1{profileId}~1ubos/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example":{"value":[{"id":"013ab1c2688d0185b582ee7e0bcb28b2","name":"John Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa","addressFirstLine":"123 Fake St","postCode":"FK 12345","ownershipPercentage":30},{"id":"912ce3f31c8b3a10572137e78417caa3","name":"Jane Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa","addressFirstLine":"125 Fake St","postCode":"FK 12545","ownershipPercentage":70}],"id":"paths/~1profiles~1{profileId}~1ubos/get/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners":{"value":[{"name":"John Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa","addressFirstLine":"123 Fake St","postCode":"FK 12345","ownershipPercentage":30},{"name":"Jane Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa","addressFirstLine":"125 Fake St","postCode":"FK 12545","ownershipPercentage":70}],"key":"twoOwners","summary":"Two beneficial owners (30/70 split)","id":"paths/~1profiles~1{profileId}~1ubos/put/requestBody/content/application~1json/examples/twoOwners"},"paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example":{"value":[{"id":"ff01cf3f206b40c090a14a1e51163e9e","name":"John Doe","dateOfBirth":"1982-05-20","countryOfResidenceIso3Code":"usa","addressFirstLine":"123 Fake St","postCode":"FK 12345","ownershipPercentage":30},{"id":"c36b687d28ad44ad8c3864411f5f2612","name":"Jane Doe","dateOfBirth":"1981-12-07","countryOfResidenceIso3Code":"usa","addressFirstLine":"125 Fake St","postCode":"FK 12545","ownershipPercentage":70}],"id":"paths/~1profiles~1{profileId}~1ubos/put/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example":{"value":{"routes":[{"source_currency":"GBP","maximum_entitled_amount":100000,"current_status":"verified"},{"source_currency":"USD","maximum_entitled_amount":0,"current_status":"not_verified"},{"source_currency":"EUR","maximum_entitled_amount":10000,"current_status":"not_verified"}],"request_id":"e66da5f6-2456-403c-bfcb-908885ee1a61"},"id":"paths/~1profiles~1{profileId}~1verification-status~1bank-transfer/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example":{"value":{"cursor":"WyJQUklPUklUWSIsMTAwMDAxNjY5NzA4MjI0MDAwMDE2MDk5OV0=","activities":[{"id":"TU9ORVRBUllfQUNUSVZJVFk6OjE0NTU4OTk4OjpDQVJEX1RSQU5TQUNUSU9OOjozNDMwNDk=","type":"CARD_PAYMENT","resource":{"type":"CARD_TRANSACTION","id":"343049"},"title":"Test Payment","description":"","primaryAmount":"150 JPY","secondaryAmount":"1.50 SGD","status":"COMPLETED","createdOn":"2023-01-01T00:00:00.000Z","updatedOn":"2023-01-01T00:00:00.000Z"}]},"id":"paths/~1profiles~1{profileId}~1activities/get/responses/200/content/application~1json/example"},"paths/~1addresses/post/responses/200/content/application~1json/example":{"value":{"id":10000001,"profile":12345678,"details":{"country":"US","state":"AZ","city":"Phoenix","postCode":"10025","firstLine":"50 Sunflower Ave","occupations":[{"code":"Software Engineer","format":"FREE_FORM"}]}},"id":"paths/~1addresses/post/responses/200/content/application~1json/example"},"paths/~1addresses/get/responses/200/content/application~1json/example":{"value":[{"id":10000001,"profile":12345678,"details":{"country":"US","state":"AZ","city":"Phoenix","postCode":"10025","firstLine":"50 Sunflower Ave","occupations":[{"code":"Software Engineer","format":"FREE_FORM"}]}}],"id":"paths/~1addresses/get/responses/200/content/application~1json/example"},"paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example":{"value":{"id":10000001,"profile":12345678,"details":{"country":"US","state":"AZ","city":"Phoenix","postCode":"10025","firstLine":"50 Sunflower Ave","occupations":[{"code":"Software Engineer","format":"FREE_FORM"}]}},"id":"paths/~1addresses~1{addressId}/get/responses/200/content/application~1json/example"},"paths/~1address-requirements/post/requestBody/content/application~1json/example":{"value":{"details":{"country":"US"}},"id":"paths/~1address-requirements/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example":{"value":{"submissionData":"{\"data\":{\"accountPurpose\":\"SENDING_MONEY_TO_FRIENDS_OR_FAMILY\"},\"version\":\"V1\",\"kycReviewId\":\"93a903ea-636c-4c86-a25c-cf6d2bd00e81\"}"},"id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/requestBody/content/multipart~1form-data/example"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/ACCOUNT_INTENT","errors":[{"code":"invalid_value","ref":"submissionData","detail":"submissionData must not be empty"}]},"key":"no-submission-data","summary":"No submissionData provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-submission-data"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/ACCOUNT_INTENT","errors":[{"code":"invalid_value","ref":"submissionData.kycReviewId","detail":"kycReviewId must not be empty"}]},"key":"no-kyc-review-id","summary":"No kycReviewId provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-kyc-review-id"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"detail":"No files or submissionData is submitted","instance":"/v2/profiles/{profileId}/kyc-requirements/ACCOUNT_INTENT","errors":[]},"key":"no-data","summary":"No data provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-data"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/ACCOUNT_INTENT","errors":[{"code":"invalid_value","ref":"accountPurpose","detail":"Invalid accountPurpose submitted: invalid","attributes":{"acceptedValues":["Consult API documentation"]}}]},"key":"invalid-field-value","summary":"Invalid field value","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-field-value"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"detail":"Amount must be greater than zero.","instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_ANNUAL_INCOME","errors":[]},"key":"negative-amount","summary":"Negative amount provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/negative-amount"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_ANNUAL_INCOME","errors":[{"code":"invalid_request","ref":"submissionData","detail":"submitted data is invalid","attributes":null}]},"key":"invalid-currency","summary":"Invalid currency provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-currency"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_AUTHORISATION_ID","errors":[{"code":"missing_value","ref":"files","detail":"No file has been provided"}]},"key":"no-files","summary":"No files provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/no-files"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_AUTHORISATION_ID","errors":[{"code":"invalid_value","ref":"files","detail":"File - filenames mismatch","attributes":{"acceptedValues":["xx.png"]}}]},"key":"mismatching-filenames","summary":"Mismatching fileNames provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/mismatching-filenames"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_AUTHORISATION_ID","errors":[{"code":"missing_value","ref":"frontSideFilename","detail":"No front side file name is provided"}]},"key":"missing-front-filename","summary":"Multiple files provided without frontFileName field","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-front-filename"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH","errors":[{"code":"invalid_value","ref":"sourceOfWealthList","detail":"No business source of wealth provided","attributes":{"acceptedValues":["REVENUE","PERSONAL_FUNDING","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER","LEGAL"]}}]},"key":"empty-source-of-wealth-list","summary":"Empty sourceOfWealthList provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-source-of-wealth-list"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH","errors":[{"code":"invalid_value","ref":"sourceOfWealthList","detail":"Missing business source of wealth description","attributes":{"acceptedValues":["REVENUE","PERSONAL_FUNDING","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER","LEGAL"]}}]},"key":"missing-wealth-description","summary":"No description when sourceOfWealthList is OTHER","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/missing-wealth-description"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH","errors":[{"code":"invalid_value","ref":"sourceOfWealthList","detail":"Source of wealth description too short","attributes":{"acceptedValues":["REVENUE","PERSONAL_FUNDING","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER","LEGAL"]}}]},"key":"wealth-description-too-short","summary":"Short description when sourceOfWealthList is OTHER","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/wealth-description-too-short"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"invalid_value","ref":"requirementKey","detail":"Transfer which triggered KycReview is not from INR currency so submission of this requirement is not permitted"}]},"key":"india-transfer-purpose-non-inr-from-currency","summary":"India transfer purpose submitted for non-INR currency","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-non-inr-from-currency"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"invalid_value","ref":"requirementKey","detail":"Transfer which triggered KycReview does not have an accepted target currency so submission of this requirement is not permitted"}]},"key":"india-transfer-purpose-not-accepted-to-currency","summary":"India transfer purpose submitted to not accepted currency","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-accepted-to-currency"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"invalid_value","ref":"code","detail":"The code provided is not valid"}]},"key":"india-transfer-purpose-invalid-code","summary":"India transfer purpose invalid code","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-invalid-code"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"invalid_value","ref":"requirementKey","detail":"INDIA_TRANSFER_PURPOSE is not required for the KycReview"}]},"key":"india-transfer-purpose-not-required","summary":"India transfer purpose not required","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-not-required"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"missing_value","ref":"additionalDocumentFileName","detail":"additionalDocumentFileName cannot be null or empty"}]},"key":"india-transfer-purpose-additionaldocumentfilename-not-supplied","summary":"additionalDocumentFileName missing or empty","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-additionaldocumentfilename-not-supplied"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"missing_value","ref":"educationPaidWithLoan","detail":"educationPaidWithLoan cannot be null"}]},"key":"india-transfer-purpose-educationpaidwithloan-not-supplied","summary":"educationPaidWithLoan missing","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-supplied"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"invalid_value","ref":"educationPaidWithLoan","detail":"educationPaidWithLoan is only valid for OVERSEAS_EDUCATION & EDUCATION_EXPENSES"}]},"key":"india-transfer-purpose-educationpaidwithloan-not-required","summary":"educationPaidWithLoan not required","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-educationpaidwithloan-not-required"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"missing_value","ref":"loanDocumentFileName","detail":"loanDocumentFileName must be provided if the code is OVERSEAS_EDUCATION or EDUCATION_EXPENSES and educationPaidWithLoan is true"}]},"key":"india-transfer-purpose-loandocumentfilename-not-supplied","summary":"loanDocumentFileName missing","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-loandocumentfilename-not-supplied"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"missing_value","ref":"passportFileName","detail":"passportFileName cannot be null or empty"}]},"key":"india-transfer-purpose-passportfilename-not-supplied","summary":"passportFileName missing or empty","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-passportfilename-not-supplied"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/INDIA_TRANSFER_PURPOSE","errors":[{"code":"missing_value","ref":"tcsTaxApplies","detail":"tcsTaxApplies cannot be null"}]},"key":"india-transfer-purpose-tcstaxapplies-not-supplied","summary":"tcsTaxApplies missing","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/india-transfer-purpose-tcstaxapplies-not-supplied"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH_INFO","errors":[{"code":"invalid_value","ref":"sourceOfWealthList","detail":"Invalid submission data provided","attributes":{"acceptedValues":["REVENUE","PERSONAL_FUNDING","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER","LEGAL"]}}]},"key":"invalid-wealth-info-data","summary":"Invalid sourceOfWealthList submission data","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-wealth-info-data"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH_PROOF","errors":[{"code":"invalid_value","ref":"sourceOfWealthType","detail":"Invalid Source of Wealth type","attributes":{"acceptedValues":["REVENUE","PERSONAL_FUNDING","BUSINESS_LOAN","FUNDING_AND_SHAREHOLDER_INVESTMENTS","INVESTMENT_INCOME","DONATIONS","GRANTS","OTHER","LEGAL"]}}]},"key":"invalid-source-of-wealth-type","summary":"Invalid sourceOfWealthType provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-source-of-wealth-type"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_SOURCE_OF_WEALTH_PROOF","errors":[{"code":"invalid_value","ref":"documentType","detail":"Invalid Document Type","attributes":{"acceptedValues":["PAYSLIP","INVOICES","CONTRACTS","TAX_DOCUMENTS","AUDITED_FINANCIAL_STATEMENTS","E_COMMERCE_STATEMENTS","PERSONAL_INVESTMENT","PERSONAL_LOAN_AGREEMENT","PERSONAL_TAX_DECLARATION","LOAN_AGREEMENT","EQUITY_AGREEMENT","SUBSCRIPTION_AGREEMENT","SAVINGS_STATEMENT","ASSET_SALE_AGREEMENT","SHARE_SALE_CERTIFICATE","DONATION_RECEIPTS","GRANT_APPROVAL_LETTER","WRITTEN_CONFIRMATION","BANK_STATEMENT"]}}]},"key":"invalid-document-type","summary":"Invalid documentType provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-document-type"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_ULTIMATE_BENEFICIAL_OWNER_ID","errors":[{"code":"invalid_value","ref":"file","detail":"No file was provided with a name that matches {fileName} for shareholderId: {shareHolderId}","attributes":null}]},"key":"shareholder-file-mismatch","summary":"File not matching fileName for shareholder","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-file-mismatch"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_ULTIMATE_BENEFICIAL_OWNER_ID","errors":[{"code":"invalid_value","ref":"shareholderId","detail":"Shareholder does not exist","attributes":null}]},"key":"shareholder-not-found","summary":"Shareholder does not exist","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-not-found"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_ULTIMATE_BENEFICIAL_OWNER_ID","errors":[{"code":"invalid_value","ref":"documentType","detail":"DocumentType cannot be associated with shareholder: {shareHolderId}","attributes":{"acceptedValues":["NATIONAL_ID","DRIVING_LICENSE","PASSPORT"]}}]},"key":"shareholder-document-type-mismatch","summary":"DocumentType not valid for shareholder","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/shareholder-document-type-mismatch"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_USE_CASE","errors":[{"code":"parameter_missing","ref":"useCases","detail":"No value provided","attributes":null}]},"key":"empty-required-array","summary":"Required array field empty","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/empty-required-array"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/BUSINESS_USE_CASE","errors":[{"code":"invalid_value","ref":"useCases","detail":"Invalid useCases are submitted: [invalid]","attributes":{"acceptedValues":["Consult API documentation"]}}]},"key":"invalid-array-values","summary":"Invalid values in array field","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-array-values"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/ID_DOCUMENT","errors":[{"code":"invalid_request","ref":"files","detail":"No file was provided with the specified fileName: xxx.png","attributes":null}]},"key":"file-name-not-found","summary":"No file matching specified fileName","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/file-name-not-found"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/ID_DOCUMENT","errors":[{"code":"invalid_value","ref":"issuingCountry","detail":"Invalid issuingCountry provided","attributes":{"acceptedValues":["Consult API documentation"]}}]},"key":"invalid-issuing-country","summary":"Invalid issuingCountry provided","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/invalid-issuing-country"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/TAX_RESIDENCY","errors":[{"code":"invalid_request","ref":"goldenVisaDeclaration","detail":"Golden visa declaration is required when all declared countries are within golden visa jurisdictions."}]},"key":"golden-visa-declaration-required","summary":"Golden visa declaration required","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-declaration-required"},"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v2/profiles/{profileId}/kyc-requirements/TAX_RESIDENCY","errors":[{"code":"invalid_request","ref":"goldenVisaDeclaration","detail":"All values in the golden visa declaration must be set to true."}]},"key":"golden-visa-values-not-true","summary":"Golden visa declaration values must be true","id":"paths/~1profiles~1{profileId}~1kyc-requirements~1{requirementKey}/post/responses/400/content/application~1json/examples/golden-visa-values-not-true"},"paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success":{"value":{"overallStatus":"SUCCESS","results":[{"evidenceRequirementKey":"accountPurpose","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"annualIncome","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"intendedCountries","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"mainSourceOfIncome","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"yearlyAnticipatedVolume","result":"SUCCESS","message":"SUCCESS"}]},"key":"success","summary":"Full success","id":"paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/success"},"paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess":{"value":{"overallStatus":"PARTIAL_SUCCESS","results":[{"evidenceRequirementKey":"accountPurpose","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"annualIncome","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"intendedCountries","result":"FAIL","message":"Could not update verification requirement at the moment"},{"evidenceRequirementKey":"mainSourceOfIncome","result":"SUCCESS","message":"SUCCESS"},{"evidenceRequirementKey":"yearlyAnticipatedVolume","result":"SUCCESS","message":"SUCCESS"}]},"key":"partialSuccess","summary":"Partial success","id":"paths/~1profiles~1{profileId}~1additional-verification~1upload-evidences/post/responses/207/content/application~1json/examples/partialSuccess"},"paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example":{"value":{"required_evidences":["SOURCE_OF_WEALTH","INCOME","USE_CASE_COUNTRIES"]},"id":"paths/~1profiles~1{profileId}~1verification-status~1required-evidences/get/responses/200/content/application~1json/example"},"paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example":{"value":"-----BEGIN PUBLIC KEY-----\nPublic Key Content\n-----END PUBLIC KEY-----\n","id":"paths/~1facetec~1public-key/get/responses/200/content/text~1plain/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example":{"value":{"redirectUrl":"https://example.com/return","targetCurrency":"USD"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example":{"value":{"url":"https://wise-sandbox.com/embedded-flows?embeddedLinkRequestId=9f5f5812-2609-4e48-8418-b64437c0c7cd#token=0d0bdc88-bcf4-43dd-85be-7ca65441db20","expiresAt":"2026-06-15T13:23:20.265Z"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1recipients/post/responses/201/content/application~1json/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example":{"value":{"redirectUrl":"https://example.com/return","method":"BACS"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example":{"value":{"url":"https://wise-sandbox.com/embedded-flows?embeddedLinkRequestId=9f5f5812-2609-4e48-8418-b64437c0c7cd#token=0d0bdc88-bcf4-43dd-85be-7ca65441db20","expiresAt":"2026-06-15T13:23:20.265Z"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1payment-instrument/post/responses/201/content/application~1json/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example":{"value":{"redirectUrl":"https://example.com/return","kycReviewId":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example":{"value":{"url":"https://wise-sandbox.com/embedded-flows?embeddedLinkRequestId=9f5f5812-2609-4e48-8418-b64437c0c7cd#token=0d0bdc88-bcf4-43dd-85be-7ca65441db20","expiresAt":"2026-06-15T13:23:20.265Z"},"id":"paths/~1profiles~1{profileId}~1embedded-flows~1link-requests~1kyc-reviews/post/responses/201/content/application~1json/example"},"paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example":{"value":{"id":"ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198","profileId":12345,"type":"RECIPIENT","clientKey":"partner-client-key","metadata":{"targetCurrency":"USD"},"redirectUrl":"https://example.com/return"},"id":"paths/~1embedded-flows~1link-requests~1{embeddedLinkRequestId}/get/responses/200/content/application~1json/example"},"paths/~1one-time-token~1status/get/responses/200/content/application~1json/example":{"value":{"oneTimeTokenProperties":{"oneTimeToken":"9f5f5812-2609-4e48-8418-b64437c0c7cd","challenges":[{"primaryChallenge":{"type":"PIN","viewData":{"attributes":{"userId":6146956}}},"alternatives":[],"required":true,"passed":false}],"validity":3600,"actionType":"BALANCE__GET_STATEMENT","userId":6146956}},"id":"paths/~1one-time-token~1status/get/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example":{"value":"","id":"paths/~1profiles~1{profileId}~1pin/post/requestBody/content/application~1jose+json/example"},"paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example":{"value":"","id":"paths/~1profiles~1{profileId}~1pin~1verify/post/requestBody/content/application~1jose+json/example"},"paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example":{"value":{"faceMap":""},"id":"paths/~1profiles~1{profileId}~1facemaps/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example":{"value":{"faceMap":""},"id":"paths/~1profiles~1{profileId}~1facemaps~1verify/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example":{"value":"","id":"paths/~1profiles~1{profileId}~1device-fingerprints/post/requestBody/content/application~1jose+json/example"},"paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example":{"value":{"deviceFingerprintId":"636a5514-aa86-4719-8700-e9a9a0ae7ea7","createdAt":"2025-05-24T07:27:58.273205554Z"},"id":"paths/~1profiles~1{profileId}~1device-fingerprints/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example":{"value":"","id":"paths/~1profiles~1{profileId}~1device-fingerprints~1verify/post/requestBody/content/application~1jose+json/example"},"paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example":{"value":{"errors":[{"code":"phone.number.repeated","message":"It's linked to an account with the email ****@wise.com"}]},"id":"paths/~1application~1users~1{userId}~1phone-numbers/post/responses/422/content/application~1json/example"},"paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example":{"value":{"oneTimeTokenProperties":{"oneTimeToken":"9f5f5812-2609-4e48-8418-b64437c0c7cd","challenges":[],"validity":3600}},"id":"paths/~1one-time-token~1sms~1verify/post/responses/200/content/application~1json/example"},"paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example":{"value":{"oneTimeTokenProperties":{"oneTimeToken":"9f5f5812-2609-4e48-8418-b64437c0c7cd","challenges":[],"validity":3600}},"id":"paths/~1one-time-token~1whatsapp~1verify/post/responses/200/content/application~1json/example"},"paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example":{"value":{"oneTimeTokenProperties":{"oneTimeToken":"9f5f5812-2609-4e48-8418-b64437c0c7cd","challenges":[],"validity":3600}},"id":"paths/~1one-time-token~1voice~1verify/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example":{"value":{"currency":"EUR","type":"STANDARD"},"id":"paths/~1profiles~1{profileId}~1balances/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion":{"value":{"quoteId":"00000000-0000-0000-0000-000000000000"},"key":"conversion","summary":"Convert between currencies","id":"paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/conversion"},"paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move":{"value":{"sourceBalanceId":1,"targetBalanceId":2,"amount":{"value":100,"currency":"EUR"}},"key":"move","summary":"Move within same currency","id":"paths/~1profiles~1{profileId}~1balance-movements/post/requestBody/content/application~1json/examples/move"},"paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened":{"value":{"schema_version":"4.0.0","subscription_id":"01234567-89ab-cdef-0123-456789abcdef","event_type":"hold-limit-breach#update","sent_at":"2024-06-01T08:00:00Z","data":{"resource":{"type":"hold-limit-breach","hold_limit_breach_id":1001,"profile_id":12321323},"amount":500.5,"currency":"SGD","state":"OPEN","closing_reason":null,"created_at":"2024-06-01T08:00:00Z","updated_at":"2024-06-01T08:00:00Z","occurred_at":"2024-06-01T08:00:00Z"}},"key":"breachOpened","summary":"Breach opened","id":"paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachOpened"},"paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed":{"value":{"schema_version":"4.0.0","subscription_id":"01234567-89ab-cdef-0123-456789abcdef","event_type":"hold-limit-breach#update","sent_at":"2024-06-02T09:15:00Z","data":{"resource":{"type":"hold-limit-breach","hold_limit_breach_id":1001,"profile_id":12321323},"amount":500.5,"currency":"SGD","state":"CLOSED","closing_reason":"MANUALLY_RESOLVED","created_at":"2024-06-01T08:00:00Z","updated_at":"2024-06-02T09:15:00Z","occurred_at":"2024-06-02T09:15:00Z"}},"key":"breachClosed","summary":"Breach closed","id":"paths/hold-limit-breach#update/post/requestBody/content/application~1json/examples/breachClosed"},"paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example":{"value":["EUR","GBP","USD"],"id":"paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1available-currencies/get/responses/200/content/application~1json/example"},"paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example":{"value":["EUR","GBP","USD"],"id":"paths/~1borderless-accounts-configuration~1profiles~1{profileId}~1payin-currencies/get/responses/200/content/application~1json/example"},"paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","profileId":12345678,"balanceId":"555555","accountDetailsId":"987654","state":"CREDITED","creditTransferType":"CUSTOMER_CREDIT_TRANSFER","scheme":"SWIFT","endToEndId":"INVOICE-2026-998","uetr":"123e4567-e89b-42d3-a456-426614174000","unstructuredReference":"/RFB/INV-2025-001","creditedTime":"2025-08-21T12:34:56.000Z","debtor":{"name":"Sarah Jenkins","address":{"streetName":"Clifton Street","buildingNumber":"65","townName":"London","postCode":"EC2A 4JE","country":"GB","addressLines":["1st Floor, Worship Square","EV2A 4JE"]},"account":{"number":"GB29NWBK60161331926819"},"agent":{"bic":"TRWIGB2L","nationalCode":"230801","name":"Wise Payments Ltd"}},"creditor":{"name":"Sarah Jenkins","account":{"number":"BE71096123456769"},"agent":{"bic":"TRWIBEB1","name":"Wise"}},"amounts":{"instructed":{"value":1000,"currency":"USD"},"interbankSettlement":{"value":1000,"currency":"USD"},"credited":{"value":625.25,"currency":"EUR"}},"exchangeRate":0.6325,"chargeBearer":"SHARED","previousInstructingAgents":[],"fees":{"wise":[{"type":"OTHER","value":7.25,"currency":"EUR"}],"correspondent":[]}},"key":"credited-swift-transfer","summary":"Credited SWIFT incoming transfer","id":"paths/~1incoming-transfers~1{incomingTransferId}/get/responses/200/content/application~1json/examples/credited-swift-transfer"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example":{"value":{"status":"ACTIVE"},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1status/put/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example":{"value":{"permissions":[{"type":"ECOM","isEnabled":true},{"type":"POS_CHIP","isEnabled":true}]},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported":{"value":{"message":"Permission 'POS_CONTACTLESS' is not supported for this card and cannot be updated"},"key":"permissionNotSupported","summary":"Permission not supported for card type","id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionNotSupported"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked":{"value":{"message":"Permission 'POS_CONTACTLESS' is locked for this card and cannot be updated"},"key":"permissionLocked","summary":"Permission is locked","id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spending-permissions/patch/responses/422/content/application~1json/examples/permissionLocked"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example":{"value":{"status":"IN_PROGRESS","kioskId":"WIS00001","occurredAt":"2024-01-01T12:24:56.121Z"},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example":{"value":{"status":"REQUEST_ERROR","kioskId":"WIS00001","occurredAt":"2024-01-01T12:24:56.121Z","errorCode":"PIN_VERIFICATION_FAILED","description":"The PIN cannot be verified because the server is unreachable"},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/put/responses/422/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example":{"value":{"status":"READY","kioskId":null,"occurredAt":"2024-01-01T12:24:56.124Z","errorCode":null,"description":"Card ready for production"},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example":{"value":{"requirements":[{"type":"PIN","status":"NOT_INITIATED"},{"type":"VERIFICATION","status":"PENDING"},{"type":"ADDRESS","status":"COMPLETED"}]},"id":"paths/~1spend~1profiles~1{profileId}~1card-orders~1{cardOrderId}~1requirements/get/responses/200/content/application~1json/example"},"paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example":{"value":{"errors":[{"field":"city","message":"Required Field"},{"field":"postCode","message":"Please enter a valid postcode"},{"field":"firstLine","message":"Must be less than 30 characters"}]},"id":"paths/~1spend~1address~1validate/post/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example":{"value":{"transactions":[{"id":342671,"cardToken":"59123122-223d-45f9-b840-0ad4a4f80937","type":"ECOM_PURCHASE","state":"IN_PROGRESS","declineReason":null,"creationTime":"2022-11-28T08:17:54.241Z","modificationTime":"2022-11-28T08:17:54.241Z","purgeTime":"2022-11-28T08:17:54.241Z","transactionAmount":{"amount":1.4,"currency":"SGD"},"fees":[{"amount":0.1,"currency":"SGD","fee_type":"ATM_ACQUIRER"}],"transactionAmountWithFees":{"amount":1.5,"currency":"SGD"},"merchant":{"name":"Test Payment","location":{"country":"France","city":"Rouen","zipCode":"00000","region":null,"state":null},"category":{"name":"MISCELLANEOUS_FOOD_STORES_CONVEN","code":"5999","description":"5999 R Miscellaneous and Special"}},"authorisationMethod":"MANUAL_ENTRY","approvalCode":"913647","billingAmount":{"amount":1.1,"currency":"EUR"},"arn":"04300014127798385983852","pinValidationResult":"ONLINE_PIN_VALIDATED","balanceChannelReferenceId":"6e71018d-2f4d-4fc3-6711-f517f4664712"}]},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example":{"value":{"spendLimits":[{"type":"PURCHASE","aggregateWindow":{"daily":{"value":{"amount":20000,"currency":"GBP"},"usage":{"amount":0,"currency":"GBP"},"max":{"amount":30000,"currency":"GBP"},"resetAt":"2023-07-31T22:59:59.999999999Z"},"monthly":{"value":{"amount":20000,"currency":"GBP"},"usage":{"amount":0,"currency":"GBP"},"max":{"amount":30000,"currency":"GBP"},"resetAt":"2023-07-31T22:59:59.999999999Z"}}},{"type":"ATM_WITHDRAWAL","aggregateWindow":{"daily":{"value":{"amount":1000,"currency":"GBP"},"usage":{"amount":0,"currency":"GBP"},"max":{"amount":4000,"currency":"GBP"},"resetAt":"2023-07-31T22:59:59.999999999Z"},"monthly":{"value":{"amount":1000,"currency":"GBP"},"usage":{"amount":0,"currency":"GBP"},"max":{"amount":4000,"currency":"GBP"},"resetAt":"2023-07-31T22:59:59.999999999Z"}}}]},"id":"paths/~1spend~1profiles~1{profileId}~1spend-limits/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example":{"value":{"type":"PURCHASE","aggregateWindow":{"daily":{"value":{"amount":20000,"currency":"GBP"}},"monthly":{"value":{"amount":20000,"currency":"GBP"}}}},"id":"paths/~1spend~1profiles~1{profileId}~1spend-limits/patch/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example":{"value":{"daily":{"value":{"amount":1000,"currency":"GBP"}},"monthly":{"value":{"amount":1000,"currency":"GBP"}}},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1spend-limits/patch/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example":{"value":{"type":"/errors/types/access","status":403,"code":"unauthorized","detail":"Operation is unauthorized"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/403/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example":{"value":{"type":"/errors/types/validation","title":"Validation error","status":422,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"invalid_value","ref":"businessProfileId","detail":"businessProfileId must reference a business profile"}]},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/422/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example":{"value":{"type":"/errors/types/server","status":500,"detail":"An unexpected error occurred"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/get/responses/500/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example":{"value":{"type":"PURCHASE","aggregateWindow":{"daily":{"value":{"amount":1000,"currency":"GBP"}},"monthly":{"value":{"amount":3000,"currency":"GBP"}}}},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"parameter_missing","ref":"aggregateWindow.daily.value","detail":"value not be null"}]},"key":"missingField","summary":"A required field is absent","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/missingField"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured":{"value":{"type":"/errors/types/validation","title":"Validation Error","status":400,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"parameter_invalid","ref":"aggregateWindow.configured","detail":"at least one of daily or monthly must be provided"}]},"key":"noWindowConfigured","summary":"Neither daily nor monthly provided","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/noWindowConfigured"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch":{"value":{"type":"/errors/types/validation","title":"Request Parameter Type Mismatch","status":400,"instance":"/v4/spend/profiles/asdq/card-holder-profiles/67890/spend-limits","errors":[{"code":"parameter_invalid_type_mismatch","ref":"businessProfileId","detail":"The parameter value is not of the expected type."}]},"key":"pathParameterTypeMismatch","summary":"Path parameter is not a valid integer","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/pathParameterTypeMismatch"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody":{"value":{"type":"/errors/types/validation","title":"Request Message Not Readable","status":400,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","description":"The request body could not be parsed. Please check that the request is valid JSON/XML and matches the expected format.","errors":[]},"key":"unreadableBody","summary":"Body is malformed or contains an unknown enum value","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/400/content/application~1json/examples/unreadableBody"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example":{"value":{"type":"/errors/types/access","status":403,"code":"unauthorized","detail":"Operation is unauthorized"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/403/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType":{"value":{"type":"/errors/types/validation","title":"Validation error","status":422,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"invalid_value","ref":"type","detail":"Unsupported limit type: ATM_WITHDRAWAL. Only PURCHASE is supported for cardholder limits."}]},"key":"unsupportedType","summary":"Unsupported limit type","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/unsupportedType"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits":{"value":{"type":"/errors/types/validation","title":"Validation error","status":422,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"invalid_value","ref":"aggregateWindow","detail":"Both daily and monthly limits are required when setting spend limits for the first time."}]},"key":"incompleteInitialLimits","summary":"Incomplete initial limits","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/incompleteInitialLimits"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch":{"value":{"type":"/errors/types/validation","title":"Validation error","status":422,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"invalid_value","ref":"businessProfileId","detail":"businessProfileId must reference a business profile"}]},"key":"profileTypeMismatch","summary":"Wrong profile type","id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/422/content/application~1json/examples/profileTypeMismatch"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example":{"value":{"type":"/errors/types/server","status":500,"detail":"An unexpected error occurred"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/patch/responses/500/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example":{"value":{"type":"/errors/types/access","status":403,"code":"unauthorized","detail":"Operation is unauthorized"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/403/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example":{"value":{"type":"/errors/types/validation","title":"Validation error","status":422,"instance":"/v4/spend/profiles/12345/card-holder-profiles/67890/spend-limits","errors":[{"code":"invalid_value","ref":"businessProfileId","detail":"businessProfileId must reference a business profile"}]},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/422/content/application~1json/example"},"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example":{"value":{"type":"/errors/types/server","status":500,"detail":"An unexpected error occurred"},"id":"paths/~1spend~1profiles~1{businessProfileId}~1card-holder-profiles~1{cardHolderProfileId}~1spend-limits/delete/responses/500/content/application~1json/example"},"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example":{"value":{"description":"Blocking all transactions from MCC 1234 and 5678","type":"MCC","operation":"BLOCK","values":["1234","5678"]},"id":"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/post/requestBody/content/application~1json/example"},"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example":{"value":[{"id":1,"description":"Blacklist gambling MCCs","type":"MCC","operation":"BLOCK","values":["7801","7802","7995","9754"]}],"id":"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules/get/responses/200/content/application~1json/example"},"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example":{"value":{"ruleId":"123"},"id":"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1apply/post/requestBody/content/application~1json/example"},"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example":{"value":{"ruleId":"123"},"id":"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1unapply/post/requestBody/content/application~1json/example"},"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example":{"value":[{"ruleId":123},{"ruleId":456}],"id":"paths/~1spend~1applications~1{clientId}~1spend-controls~1rules~1applied/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example":{"value":{"paymentTokens":[{"cardToken":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","walletName":"GOOGLE_PAY","paymentTokenUniqueReference":"DSHRMC0000255389d1106783179b420aa5b5ca09ba2f12b8","panUniqueReference":"FSHRMC000025538959679bc73c9d4fdc8031b20fa91d0e3b","provisioningStatus":"ACTIVE","creationTime":"2025-02-06T15:34:23.877041000Z","modificationTime":"2025-02-06T15:34:23.877343000Z"},{"cardToken":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","walletName":"GOOGLE_PAY","paymentTokenUniqueReference":"DSHRMC0000255389e2f7133754ab4e2f87fc323730fdfd8e","panUniqueReference":"","provisioningStatus":"INACTIVE","creationTime":"2025-06-25T22:05:47.116016000Z","modificationTime":"2025-06-25T22:05:47.116077000Z"},{"cardToken":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","walletName":"APPLE_PAY","paymentTokenUniqueReference":"DAPLMC000025538967ea1d7972414a93a6544a07dae27a8c","panUniqueReference":"FAPLMC0000255389d7df244df7244803aa2c4ce2a29c242a","provisioningStatus":"ACTIVE","creationTime":"2025-08-19T21:28:28.434472000Z","modificationTime":"2025-08-19T21:28:28.434738000Z"},{"cardToken":"a3f90c98-1cd1-4488-9050-2e32c696f8fa","walletName":"APPLE_PAY","paymentTokenUniqueReference":"DAPLMC0000255389c25cd65bf8084c168dbc4aa59708841a","panUniqueReference":"FAPLMC0000255389d7df244df7244803aa2c4ce2a29c242a","provisioningStatus":"SUSPENDED","creationTime":"2025-08-04T01:37:30.658315000Z","modificationTime":"2025-08-04T01:37:30.658552000Z"}]},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens/post/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example":{"value":{"activation":"APPROVE"},"id":"paths/~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1payment-tokens~1{paymentTokenUniqueReference}~1activation/post/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example":{"value":{"email":"support@partner.com"},"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example":{"value":{"key":"TROUBLE_WITH_GOODS_SERVICES","type":"form","title":"There's a problem with the goods or service I ordered","actions":[],"schemas":[],"layout":[{"type":"decision","options":[{"title":"I never got the goods or service I ordered","action":{"url":"/v3/spend/profiles/12345/dispute-form/flows/visa/no-goods-or-services?transactionId=6789","method":"GET"},"disabled":false,"description":"Choose this if the order was cancelled or never arrived"},{"title":"Something is wrong with the goods or service I ordered","action":{"url":"/v3/spend/profiles/12345/dispute-form/flows/visa/something-wrong-what-was-received?transactionId=6789","method":"GET"},"disabled":false},{"title":"I think there might be an issue with the merchant","action":{"url":"/v3/spend/profiles/12345/dispute-form/flows/visa/scam?transactionId=6789","method":"GET"},"disabled":false,"description":"Choose this if you haven't heard from the merchant, or have found scam reviews"}]}]},"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1step~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example":{"value":[{"code":"ATM_DISPENSED_NO_FUNDS","description":"I didn't receive the money from the ATM or cash machine","isFraud":false,"supportsMultipleTransactions":false,"tooltip":"Choose this if the ATM did not dispense the money or gave you less than expected"},{"code":"WRONG_AMOUNT","description":"I was charged the wrong amount or currency","isFraud":false,"supportsMultipleTransactions":false,"tooltip":"Choose this if you were overcharged or the payment was in a different currency than you were expecting"},{"code":"TROUBLE_WITH_GOODS_SERVICES","description":"There's a problem with the goods or service I ordered","isFraud":false,"supportsMultipleTransactions":false,"tooltip":"Choose this if the goods or service never arrived, or if the product was defective or different from what you expected"},{"code":"MERCHANT_CHARGED_AGAIN","description":"I got an unexpected charge from a merchant","isFraud":false,"supportsMultipleTransactions":false,"tooltip":"Choose this for subscription charges, when you've paid twice for one purchase, or when you know the merchant from a past transaction but aren't sure why they charged you"},{"code":"NO_REFUND","description":"I haven't received the refund","isFraud":false,"supportsMultipleTransactions":false,"tooltip":"Choose this when you've been promised a refund and it hasn't arrived"},{"code":"UNAUTHORIZED","description":"I did not make, authorize, or participate in this transaction","tooltip":"Choose this if you don't know the merchant or have never purchased anything from them","subOptions":[{"code":"UNEXPECTEDLY_CHARGED_AGAIN","description":"A past merchant unexpectedly charged me again","isFraud":false,"supportsMultipleTransactions":false},{"code":"UNWANTED_SUBSCRIPTION","description":"I've been charged for a subscription without my permission","isFraud":false,"supportsMultipleTransactions":false},{"code":"CARD_POSSESSION","description":"I don't recognise a transaction","isFraud":true,"supportsMultipleTransactions":true,"tooltip":"Choose this if you had your card at the time of the transactions, or if you think your card details have been compromised"},{"code":"CARD_NO_POSSESSION","description":"My card was lost or stolen","isFraud":true,"supportsMultipleTransactions":true,"tooltip":"Choose this if you didn't have your card at the time of the transactions"}]}],"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1reasons/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example":{"value":{"transaction":{"transactionId":"12345","email":"support@partner.com"},"form":{"charged":{"value":50,"currency":"EUR"},"expected":{"value":5,"currency":"EUR"},"agreedDetails":{"agreed":true,"agreedReason":"some reason"},"goods":"something","details":"wrong amount dispute"},"disclaimer":{"allAnswered":true,"filesUploaded":true}},"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example":{"value":{"key":"final","type":"form","title":"Done!","actions":[{"title":"Continue","exit":true,"$id":"continue"}],"schemas":[],"layout":[{"width":"md","components":[{"url":"https://wise.com/web-art/assets/illustrations/email-success-large%402x.png","type":"image"}],"type":"box"},{"margin":"lg","align":"center","type":"info","markdown":"Thanks for reporting this transaction. It's pre-authorised right now, but as soon as it becomes \"spent\" we'll begin our investigation."},{"type":"button","action":{"$ref":"continue"}}]},"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1flows~1{scheme}~1{reason}/post/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example":{"value":{"receipt":"ab4f5d2"},"id":"paths/~1spend~1profiles~1{profileId}~1dispute-form~1file/post/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example":{"value":{"totalCount":2,"disputes":[{"id":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb","transactionId":2040,"profileId":16605997,"reason":"NEVER_ARRIVED","status":"ACTIVE","subStatus":"SUBMITTED","statusMessage":"Submitted","createdAt":"2024-03-08T08:30:14.989Z","createdBy":"6097861","lastUpdatedAt":"2024-03-08T08:30:14.989Z","canWithdraw":true},{"id":"9c5ca0cb-00d6-41f7-8214-8cfdb11388a7","transactionId":3405,"profileId":16605997,"reason":"CANCELLED_ORDER","status":"ACTIVE","subStatus":"SUBMITTED","statusMessage":"Submitted","createdAt":"2024-03-27T02:24:16.878Z","createdBy":"6097861","lastUpdatedAt":"2024-03-27T02:24:16.878Z","canWithdraw":true}]},"id":"paths/~1spend~1profiles~1{profileId}~1disputes/get/responses/200/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example":{"value":{"status":"CLOSED"},"id":"paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/requestBody/content/application~1json/example"},"paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example":{"value":{"id":"51e2dc60-9e4b-4ff5-b917-b90cc5e1ecfb","transactionId":2040,"profileId":16605997,"reason":"NEVER_ARRIVED","status":"CLOSED","subStatus":"WITHDRAWN","statusMessage":"Withdrawn","createdAt":"2024-03-08T08:30:14.989Z","createdBy":"6097861","lastUpdatedAt":"2024-03-27T13:12:28.390Z","canWithdraw":false},"id":"paths/~1spend~1profiles~1{profileId}~1disputes~1{disputeId}~1status/put/responses/200/content/application~1json/example"},"paths/~1rates/get/responses/400/content/application~1json/examples/badRequest":{"value":{"error":"Bad Request","message":"Invalid parameters","path":null,"status":400,"timestamp":"2026-01-01T06:56:29.923935466Z"},"key":"badRequest","summary":"badRequest","id":"paths/~1rates/get/responses/400/content/application~1json/examples/badRequest"},"paths/~1comparisons/get/responses/200/content/application~1json/example":{"value":{"sourceCurrency":"GBP","targetCurrency":"EUR","sourceCountry":null,"targetCountry":null,"providerCountry":null,"providerTypes":["bank","moneyTransferProvider"],"amount":10000,"amountType":"SEND","providers":[{"id":39,"alias":"wise","name":"Wise","logos":{"normal":{"svgUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo.svg","pngUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo.png"},"inverse":{"svgUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.svg","pngUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo_inverse.png"},"white":{"svgUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo_white.svg","pngUrl":"https://wise.com/public-resources/assets/logos/wise-personal/logo_white.png"},"circle":{"svgUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/wise-mark.svg","pngUrl":null},"altText":"Wise"},"type":"moneyTransferProvider","partner":false,"quotes":[{"rate":1.15989,"fee":37.12,"dateCollected":"2019-10-22T14:36:43Z","sourceCountry":null,"targetCountry":null,"markup":0,"receivedAmount":11555.84,"sendAmount":null,"deliveryEstimation":{"duration":{"min":"PT20H8M16.305111S","max":"PT20H8M16.305111S"},"providerGivesEstimate":true},"isConsideredMidMarketRate":true}]},{"id":1,"alias":"barclays","name":"Barclays","logos":{"normal":{"svgUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/barclays.svg","pngUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/barclays.png"},"inverse":{"svgUrl":null,"pngUrl":null},"white":{"svgUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/barclays--white.svg","pngUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/barclays--white.png"},"circle":{"svgUrl":"https://dq8dwmysp7hk1.cloudfront.net/logos/barclays-mark.svg","pngUrl":null},"altText":"Barclays"},"type":"bank","partner":false,"quotes":[{"rate":1.12792426,"fee":0,"dateCollected":"2019-10-22T14:00:04Z","sourceCountry":"GB","targetCountry":"ES","markup":2.75592858,"receivedAmount":11279.24,"sendAmount":null,"deliveryEstimation":{"duration":{"min":"PT24H","max":"PT24H"},"providerGivesEstimate":true},"isConsideredMidMarketRate":false}]}]},"id":"paths/~1comparisons/get/responses/200/content/application~1json/example"},"paths/~1accounts/get/responses/200/content/application~1json/example":{"value":{"content":[{"id":40000000,"creatorId":41000000,"profileId":30000000,"name":{"fullName":"John Doe","givenName":null,"familyName":null,"middleName":null,"patronymicName":null,"cannotHavePatronymicName":null},"currency":"GBP","country":"GB","type":"SortCode","legalEntityType":"PERSON","active":true,"details":{"reference":null,"sortCode":"040075","accountNumber":"37778842","hashedByLooseHashAlgorithm":"ad245621b974efa3ef870895c3wer419a3f01af18a8a5790b47645dba6304194"},"commonFieldMap":{"accountNumberField":"accountNumber","bankCodeField":"sortCode"},"hash":"666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479","accountSummary":"(04-00-75) 37778842","longAccountSummary":"GBP account ending in 8842","displayFields":[{"key":"details/sortCode","label":"UK sort code","value":"04-00-75"},{"key":"details/accountNumber","label":"Account number","value":"37778842"}],"isInternal":false,"ownedByCustomer":false}],"seekPositionForNext":40000001,"seekPositionForCurrent":40000000,"sort":{"empty":true,"sorted":false,"unsorted":true},"size":20},"id":"paths/~1accounts/get/responses/200/content/application~1json/example"},"paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient":{"value":{"currency":"GBP","type":"sort_code","profile":30000000,"ownedByCustomer":true,"accountHolderName":"John Doe","details":{"legalType":"PRIVATE","sortCode":"040075","accountNumber":"37778842","dateOfBirth":"1961-01-01"}},"key":"GBP recipient","summary":"GBP recipient","id":"paths/~1accounts/post/requestBody/content/application~1json/examples/GBP recipient"},"paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient":{"value":{"profile":30000000,"accountHolderName":"John Doe","currency":"EUR","type":"email","details":{"email":"john.doe@transfer-world.com"}},"key":"Email recipient","summary":"Email recipient","id":"paths/~1accounts/post/requestBody/content/application~1json/examples/Email recipient"},"paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse":{"value":{"error_description":"Invalid token","error":"invalid_token"},"key":"UnauthorizedResponse","summary":"UnauthorizedResponse","id":"paths/~1accounts/post/responses/401/content/application~1json/examples/UnauthorizedResponse"},"paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example":{"value":{"accountId":40000000,"quoteId":"00000000-0000-0000-0000-000000000000","confirmations":{"acceptedOutcomes":false,"acceptedAt":null,"quoteId":"00000000-0000-0000-0000-000000000000","outcomes":[{"type":"NAME_MATCHING","outcome":"PARTIAL_FAILURE","requiresCustomerAcceptance":true,"fieldsChecked":["name/fullName","details/accountNumber"],"message":"The name entered is slightly different to the name on the account.","providedName":"John Doe","resolvedName":"Joe Doe","recommendedUpdates":[{"path":"name/fullName","value":"Joe Doe"}]}]}},"id":"paths/~1accounts~1{accountId}~1quotes~1{quoteId}~1compatibility/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example":{"value":{"identifier":"@JonathanP","targetCurrency":"EUR"},"id":"paths/~1profiles~1{profileId}~1contacts/post/requestBody/content/application~1json/example"},"paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example":{"value":{"contactId":"00000000-0000-0000-0000-000000000000","name":"Jonathan Peters"},"id":"paths/~1profiles~1{profileId}~1contacts/post/responses/200/content/application~1json/example"},"paths/~1transfer-requirements/post/requestBody/content/application~1json/example":{"value":{"targetAccount":8692237,"quoteUuid":"8fa9be20-ba43-4b15-abbb-9424e1481050","originatorLegalEntityType":"PRIVATE","details":{"reference":"Invoice 2026-001","sourceOfFunds":"verification.source.of.funds.salary","transferPurpose":"verification.transfers.purpose.pay.bills"}},"id":"paths/~1transfer-requirements/post/requestBody/content/application~1json/example"},"paths/~1transfer-requirements/post/responses/200/content/application~1json/example":{"value":[{"type":"transfer","fields":[{"name":"Transfer reference","group":[{"key":"reference","name":"Transfer reference","type":"text","refreshRequirementsOnChange":false,"required":false,"displayFormat":null,"example":null,"minLength":null,"maxLength":10,"validationRegexp":"[a-zA-Z0-9- ]*","validationAsync":null,"valuesAllowed":null}]},{"name":"Transfer purpose","group":[{"key":"transferPurpose","name":"Transfer purpose","type":"select","refreshRequirementsOnChange":true,"required":true,"displayFormat":null,"example":null,"minLength":null,"maxLength":null,"validationRegexp":null,"validationAsync":null,"valuesAllowed":[{"key":"verification.transfers.purpose.purchase.property","name":"Buying property abroad"},{"key":"verification.transfers.purpose.pay.bills","name":"Rent or other property expenses"},{"key":"verification.transfers.purpose.mortgage","name":"Mortgage payment"},{"key":"verification.transfers.purpose.pay.tuition","name":"Tuition fees or studying expenses"},{"key":"verification.transfers.purpose.send.to.family","name":"Sending money home to family"},{"key":"verification.transfers.purpose.living.expenses","name":"General monthly living expenses"},{"key":"verification.transfers.purpose.other","name":"Other"}]},{"key":"transferPurposeSubTransferPurpose","name":"Please select a specific reason for your transfer","type":"select","refreshRequirementsOnChange":true,"required":true,"displayFormat":null,"example":null,"minLength":null,"maxLength":null,"validationRegexp":null,"validationAsync":null,"valuesAllowed":[{"key":"INTERPRETATION_SERVICE","name":"Interpretation service"},{"key":"TRANSLATION_SERVICE","name":"Translation service"},{"key":"HUMAN_RESOURCE_SERVICE","name":"Human resource service"},{"key":"SOFTWARE_DEVELOPMENT_SERVICE","name":"Software development service"}]}]},{"name":"Source of funds","group":[{"key":"sourceOfFunds","name":"Source of funds","type":"select","refreshRequirementsOnChange":true,"required":true,"displayFormat":null,"example":null,"minLength":null,"maxLength":null,"validationRegexp":null,"validationAsync":null,"valuesAllowed":[{"key":"verification.source.of.funds.salary","name":"Salary"},{"key":"verification.source.of.funds.investment","name":"Investments (stocks, properties, etc.)"},{"key":"verification.source.of.funds.inheritance","name":"Inheritance"},{"key":"verification.source.of.funds.loan","name":"Loan"},{"key":"verification.source.of.funds.other","name":"Other"}]}]}]}],"id":"paths/~1transfer-requirements/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance":{"value":{"type":"BALANCE","balanceId":45678901},"key":"fund-transfer-balance","summary":"BALANCE - Fund from a Wise balance (Pre-Funded Wise Balance)","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-balance"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk":{"value":{"type":"TRUSTED_PRE_FUND_BULK","partnerReference":"PARTNER-REF-4711"},"key":"fund-transfer-trusted-pre-fund-bulk","summary":"TRUSTED_PRE_FUND_BULK - Cross Currency Bulk Settlement","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx":{"value":{"type":"TRUSTED_PRE_FUND_TX","partnerReference":"PARTNER-REF-4711"},"key":"fund-transfer-trusted-pre-fund-tx","summary":"TRUSTED_PRE_FUND_TX - Per-transaction trusted pre-fund","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/requestBody/content/application~1json/examples/fund-transfer-trusted-pre-fund-tx"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed":{"value":{"type":"BALANCE","status":"COMPLETED","balanceTransactionId":987654321},"key":"fund-transfer-balance-completed","summary":"BALANCE - completed","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-completed"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds":{"value":{"type":"BALANCE","status":"REJECTED","errorCode":"balance.insufficient-funds"},"key":"fund-transfer-balance-rejected-insufficient-funds","summary":"BALANCE - rejected (insufficient funds)","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-balance-rejected-insufficient-funds"},"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed":{"value":{"type":"TRUSTED_PRE_FUND_BULK","status":"COMPLETED","partnerReference":"PARTNER-REF-4711"},"key":"fund-transfer-trusted-pre-fund-bulk-completed","summary":"TRUSTED_PRE_FUND_BULK - completed","id":"paths/~1profiles~1{profileId}~1transfers~1{transferId}~1payments/post/responses/201/content/application~1json/examples/fund-transfer-trusted-pre-fund-bulk-completed"},"paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example":{"value":{"processorName":"Acme Bank Ltd.","deliveryMode":"SWIFT","bankingPartnerReference":"ABCD1234","bankingPartnerName":"Global Bank Corp.","mt103":"{1:F01XXXXGBXXAXXX0000000000}{2:I103XXXXGBXXXXXXN}{3:{108:1234567}{111:001}{121:00000000-0000-0000-0000-000000000000}}{4:\n:20:1234567\n:23B:CRED\n:32A:221212USD12345,\n:33B:USD12345,\n:50K:/11111111\nSOME COMPANY INC.\n1 SOME STREET MIAMI 33132 US\n:59:/GB00000000000000\nCOMPANY NAME LTD\nUK LONDON 1234 GB\n:70:REFERENCE\n:71A:OUR\n:71G:USD11,\n-}\n"},"id":"paths/~1transfers~1{transferId}~1invoices~1bankingpartner/get/responses/200/content/application~1json/example"},"paths/~1transfers/post/requestBody/content/application~1json/examples/basic":{"value":{"targetAccount":8692237,"quoteUuid":"8fa9be20-ba43-4b15-abbb-9424e1481050","customerTransactionId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","details":{"reference":"Invoice 2026-001"}},"key":"basic","summary":"Basic transfer","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/basic"},"paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements":{"value":{"targetAccount":8692237,"quoteUuid":"8fa9be20-ba43-4b15-abbb-9424e1481050","customerTransactionId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","details":{"reference":"Invoice 2026-001","transferPurpose":"verification.transfers.purpose.pay.bills","transferPurposeSubTransferPurpose":"INTERPRETATION_SERVICE","sourceOfFunds":"verification.source.of.funds.salary"}},"key":"with-transfer-requirements","summary":"With conditionally required fields","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/with-transfer-requirements"},"paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator":{"value":{"profileId":123456789,"targetAccount":7839323,"quote":"3522e360-356a-4e37-9f99-94a21898d8fa","originalTransferId":"4711","details":{"reference":"Ski trip"},"originator":{"legalEntityType":"PRIVATE","accountDetails":"123456789","reference":"CST-2991992","name":{"givenName":"John","middleNames":["Ryan"],"familyName":"Godspeed","patronymicName":"Fitz"},"dateOfBirth":"1977-07-01","nationality":"EE","address":{"firstLine":"Salu tee 100, Apt 4B","city":"Tallinn","countryCode":"EE","postCode":"12112"}}},"key":"1.create-third-party-transfer-private-originator","summary":"PRIVATE Originator","id":"paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/1.create-third-party-transfer-private-originator"},"paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator":{"value":{"profileId":123456789,"targetAccount":7839323,"quote":"3522e360-356a-4e37-9f99-94a21898d8fa","originalTransferId":"4711","details":{"reference":"Ski trip"},"originator":{"legalEntityType":"BUSINESS","reference":"78976","name":{"fullName":"Hot Air Balloon Services Ltd"},"businessRegistrationCode":"AE-89780","businessRegistrationDate":"2020-01-15","address":{"firstLine":"Salu tee 100, Apt 4B","city":"Tallinn","countryCode":"EE","postCode":"12112"}}},"key":"2.create-third-party-transfer-business-originator","summary":"BUSINESS Originator","id":"paths/~1profiles~1{profileId}~1third-party-transfers/post/requestBody/content/application~1json/examples/2.create-third-party-transfer-business-originator"},"paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity":{"value":{"id":16521632,"originalTransferId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","user":4342275,"targetAccount":8692237,"sourceAccount":1527389,"quote":"8fa9be20-ba43-4b15-abbb-9424e1481050","status":"cancelled","rate":0.89,"details":{"reference":"T475890"},"hasActiveIssues":false,"sourceCurrency":"EUR","sourceValue":0,"targetCurrency":"GBP","targetValue":150,"originator":{"legalEntityType":"BUSINESS","name":{"fullName":"Hot Air Balloon Services Ltd"},"reference":"CST-2991992","businessRegistrationCode":"83920-546","businessRegistrationDate":"2020-01-15","address":{"firstLine":"Salu tee 14","city":"Tallinn","stateCode":"","countryCode":"EE","postCode":"12112"},"accountDetails":"23456789"},"created":"2025-10-29T12:28:16.000Z"},"key":"response-business-legalentity","summary":"BUSINESS Originator Response","id":"paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-business-legalentity"},"paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity":{"value":{"id":16521632,"originalTransferId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","user":4342275,"targetAccount":8692237,"sourceAccount":1527389,"quote":"8fa9be20-ba43-4b15-abbb-9424e1481050","status":"cancelled","rate":0.89,"details":{"reference":"Testing"},"hasActiveIssues":false,"sourceCurrency":"EUR","sourceValue":0,"targetCurrency":"GBP","targetValue":150,"originator":{"legalEntityType":"PRIVATE","name":{"givenName":"John","middleNames":["Ryan"],"familyName":"Godspeed","patronymicName":"Fitz"},"dateOfBirth":"1977-07-01","nationality":"EE","reference":"CST-2991992","address":{"firstLine":"Salu tee 14","city":"Tallinn","stateCode":"","countryCode":"EE","postCode":"12112"},"accountDetails":"23456789"},"created":"2025-10-29T12:28:16.000Z"},"key":"response-private-legalentity","summary":"PRIVATE Originator Response","id":"paths/~1profiles~1{profileId}~1third-party-transfers/post/responses/201/content/application~1json/examples/response-private-legalentity"},"paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity":{"value":{"id":16521632,"originalTransferId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","user":4342275,"targetAccount":8692237,"sourceAccount":1527389,"quote":"8fa9be20-ba43-4b15-abbb-9424e1481050","status":"cancelled","rate":0.89,"details":{"reference":"T475890"},"hasActiveIssues":false,"sourceCurrency":"EUR","sourceValue":0,"targetCurrency":"GBP","targetValue":150,"originator":{"legalEntityType":"BUSINESS","name":{"fullName":"John Godspeed"},"reference":"CST-2991992","businessRegistrationCode":"83920-546","businessRegistrationDate":"2020-01-15","address":{"firstLine":"Salu tee 14","city":"Tallinn","stateCode":"","countryCode":"EE","postCode":"12112"},"accountDetails":"23456789"},"created":"2025-10-29T12:28:16.000Z"},"key":"response-business-legalentity","summary":"BUSINESS Originator Response","id":"paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-business-legalentity"},"paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity":{"value":{"id":16521632,"originalTransferId":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","user":4342275,"targetAccount":8692237,"sourceAccount":1527389,"quote":"8fa9be20-ba43-4b15-abbb-9424e1481050","status":"cancelled","rate":0.89,"details":{"reference":"Testing"},"hasActiveIssues":false,"sourceCurrency":"EUR","sourceValue":0,"targetCurrency":"GBP","targetValue":150,"originator":{"legalEntityType":"PRIVATE","name":{"givenName":"John","middleNames":["Ryan"],"familyName":"Godspeed","patronymicName":"Fitz"},"dateOfBirth":"1977-07-01","nationality":"EE","reference":"CST-2991992","address":{"firstLine":"Salu tee 14","city":"Tallinn","stateCode":"","countryCode":"EE","postCode":"12112"},"accountDetails":"23456789"},"created":"2025-10-29T12:28:16.000Z"},"key":"response-private-legalentity","summary":"PRIVATE Originator Response","id":"paths/~1profiles~1{profileId}~1third-party-transfers~1{transferId}/get/responses/200/content/application~1json/examples/response-private-legalentity"},"paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example":{"value":{"estimatedDeliveryDate":"2018-01-10T12:15:00.000+0000","formattedEstimatedDeliveryDate":"in seconds"},"id":"paths/~1delivery-estimates~1{transferId}/get/responses/200/content/application~1json/example"},"paths/~1currencies/get/responses/200/content/application~1json/example":{"value":[{"code":"AUD","symbol":"A$","name":"Australian dollar","countryKeywords":["AUD","AU","Australia","aus"],"supportsDecimals":true},{"code":"JPY","symbol":"¥","name":"Japanese yen","countryKeywords":["JPY","JP","Japan","jpn"],"supportsDecimals":false}],"id":"paths/~1currencies/get/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example":{"value":{"id":"54a6bc09-cef9-49a8-9041-f1f0c654cd88","version":0,"name":"My batch group","sourceCurrency":"GBP","status":"NEW","transferIds":[],"payInDetails":[]},"id":"paths/~1profiles~1{profileId}~1batch-groups/post/responses/201/content/application~1json/example"},"paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency":{"value":{"type":"TRUSTED_BULK_SETTLEMENT","settlementReference":"TPFB190322","settlementDate":"2019-03-22T23:59:59-05:00","transfers":[{"id":125678,"date":"2019-03-22T10:00:12-05:00","sourceAmount":23.24,"sourceCurrency":"USD","customerName":"Joe Bloggs","partnerReference":"11111","comment":"Extra Data"},{"id":178889,"date":"2019-03-23T12:40:05-05:00","sourceAmount":125.67,"sourceCurrency":"USD","customerName":"Mat Newman","partnerReference":"11112","comment":"Extra Data"}],"refundedTransfers":[{"id":178880,"partnerReference":"11108"}],"balanceTransfer":0},"key":"sameCurrency","summary":"Same Currency Settlement","id":"paths/~1settlements/post/requestBody/content/application~1json/examples/sameCurrency"},"paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency":{"value":{"type":"TRUSTED_BULK_SETTLEMENT","settlementReference":"TPFB190322","settlementDate":"2019-03-22T23:59:59-05:00","settlementCurrency":"USD","transfers":[{"id":125678,"date":"2019-03-22T10:00:12-05:00","sourceAmount":23.24,"sourceCurrency":"PHP","customerName":"Joe Bloggs","partnerReference":"11111","comment":"Extra Data","exchangeRate":0.875469},{"id":178889,"date":"2019-03-23T12:40:05-05:00","sourceAmount":125.67,"sourceCurrency":"PHP","customerName":"Mat Newman","partnerReference":"11112","comment":"Extra Data","exchangeRate":0.875469}],"refundedTransfers":[{"id":178880,"partnerReference":"11108"},{"id":178881,"partnerReference":"11109"}],"balanceTransfer":0},"key":"crossCurrency","summary":"Cross Currency Settlement","id":"paths/~1settlements/post/requestBody/content/application~1json/examples/crossCurrency"},"paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example":{"value":{"id":"72195556-e5cb-495e-a010-b37a4f2a3043","name":"Webhook Subscription #1","delivery":{"version":"4.0.0","url":"https://your.webhook.url/12345"},"trigger_on":"transfers#state-change","scope":{"domain":"profile","id":""},"created_by":{"type":"user","id":""},"created_at":"2019-10-10T13:55:57Z"},"id":"paths/~1profiles~1{profileId}~1subscriptions/post/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example":{"value":[{"id":"e889e085-3677-4110-be26-3e9160ac9f25","name":"#1 subscription","delivery":{"version":"2.0.0","url":"https://your.webhook.url/12345"},"trigger_on":"transfers#state-change","scope":{"domain":"profile","id":""},"created_by":{"type":"user","id":""}},{"id":"eabeb3f5-c134-4a1c-99e2-86a1163daf1b","name":"#2 subscription","delivery":{"version":"2.0.0","url":"https://your.webhook.url/12345"},"trigger_on":"transfers#state-change","scope":{"domain":"profile","id":""},"created_by":{"type":"user","id":""}}],"id":"paths/~1profiles~1{profileId}~1subscriptions/get/responses/200/content/application~1json/example"},"paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example":{"value":{"id":"f215f353-35fd-405b-b27f-4fd603c905ed","name":"Webhook Subscription #1","delivery":{"version":"2.0.0","url":"https://your.webhook.url/12345"},"trigger_on":"balances#credit","scope":{"domain":"profile","id":""},"created_by":{"type":"user","id":""},"created_at":"2008-09-15T15:53:00Z"},"id":"paths/~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses/200/content/application~1json/example"},"paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example":{"value":{"id":15574445,"user":294205,"targetAccount":7993919,"sourceAccount":null,"quote":113379,"status":"processing","reference":"good times","rate":1.2151,"created":"2017-03-14 15:25:51","business":null,"transferRequest":null,"details":{"reference":"good times"},"hasActiveIssues":false,"sourceValue":1000,"sourceCurrency":"EUR","targetValue":895.32,"targetCurrency":"GBP"},"id":"paths/~1simulation~1transfers~1{transferId}~1{status}/get/responses/200/content/application~1json/example"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty":{"value":{},"key":"empty","summary":"Random failure reason","id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/empty"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId":{"value":{"failure_reason_code":"WRONG_ID_NUMBER"},"key":"wrongId","summary":"Explicit failure reason","id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/requestBody/content/application~1json/examples/wrongId"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example":{"value":{"failure_reason_code":"WRONG_ID_NUMBER","failure_description":"Invalid recipient's ID document number","occurred_at":"2023-08-10T10:17:23.123Z"},"id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/200/content/application~1json/example"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode":{"value":{"errors":[{"arguments":[],"code":"invalid_failure_reason_code","message":"The provided failure reason code 'INVALID_CODE' is not recognized"}]},"key":"invalidFailureReasonCode","summary":"Invalid failure reason code provided","id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidFailureReasonCode"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState":{"value":{"errors":[{"arguments":[],"code":"invalid_transfer_state","message":"Transfer must be in BOUNCED_BACK state to simulate payout failure. Current state: OUTGOING_PAYMENT_SENT"}]},"key":"invalidTransferState","summary":"Transfer not in `BOUNCED_BACK` state","id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/400/content/application~1json/examples/invalidTransferState"},"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example":{"value":{"errors":[{"code":"system_error","message":"Something went wrong in our side. Please try again in 5 minutes. If this does not help, please let us know api@wise.com"}]},"id":"paths/~1simulation~1transfers~1{transferId}~1payout-failure/post/responses/500/content/application~1json/example"},"paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example":{"value":{"profileId":2,"balanceId":5,"currency":"EUR","amount":100,"channel":"TRANSFER"},"id":"paths/~1simulation~1balance~1topup/post/requestBody/content/application~1json/example"},"paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example":{"value":{"transactionId":5,"state":"COMPLETED","balancesAfter":[{"id":5,"value":100,"currency":"EUR"}]},"id":"paths/~1simulation~1balance~1topup/post/responses/200/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase":{"value":{"pos":"CHIP_AND_PIN","transactionType":"GOODS_AND_SERVICES","amount":{"value":10,"currency":"SGD"},"mcc":5499,"cardNumber":"4242424242424242"},"key":"POS purchase","summary":"POS purchase","id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/POS purchase"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase":{"value":{"pos":"E_COMMERCE_NO_3DS","transactionType":"GOODS_AND_SERVICES","amount":{"value":10,"currency":"SGD"},"mcc":5499,"cardNumber":"4242424242424242"},"key":"E-commerce purchase","summary":"E-commerce purchase","id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/E-commerce purchase"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal":{"value":{"pos":"CHIP_AND_PIN","transactionType":"CASH_WITHDRAWAL","amount":{"value":10,"currency":"SGD"},"mcc":6011,"cardNumber":"4242424242424242"},"key":"ATM withdrawal","summary":"ATM withdrawal","id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/ATM withdrawal"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund":{"value":{"pos":"CHIP_AND_PIN","transactionType":"REFUND","amount":{"value":10,"currency":"SGD"},"mcc":5499,"cardNumber":"4242424242424242"},"key":"Refund","summary":"Refund","id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/requestBody/content/application~1json/examples/Refund"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example":{"value":{"reference":{"transaction":{"acquirer":{"institutionId":"430010","name":"ACQUIRER NAME","city":"CITY NAME","merchantCategoryCode":5499,"country":"GB","acceptorTerminalId":"TERMID01","acceptorIdCode":"CARD ACCEPTOR","forwardingInstitutionId":"400050"},"card":{"token":"59123122-223d-45f9-b840-0ad4a4f80937","schemeName":"VISA","pan":"4242424242424242","pin":"1234","cvv1":"123","icvv":"456","cvv2":"789","expiration":[2029,7],"sequenceNumber":1,"profileId":2,"userId":5,"cardStatus":"ACTIVE","country":"SG","currencies":["SGD"]},"pos":{"type":"CHIP_AND_PIN","acceptsOnlinePins":true,"maxPinLength":12,"supports3ds":false,"hasChip":true},"transactionStartTime":1667541087.0476434,"stan":"363054","schemeTransactionId":"932290252416153","retrievalReferenceNum":"230805363054"},"requestMti":"0200","authorizationIdResponse":"123646"},"error":null},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1authorisation/post/responses/200/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example":{"value":{"amount":{"value":10,"currency":"SGD"},"transactionType":"GOODS_AND_SERVICES","ref":{"transaction":{"acquirer":{"institutionId":"430010","name":"ACQUIRER NAME","city":"CITY NAME","merchantCategoryCode":5499,"country":"GB","acceptorTerminalId":"TERMID01","acceptorIdCode":"CARD ACCEPTOR","forwardingInstitutionId":"400050"},"card":{"token":"59123122-223d-45f9-b840-0ad4a4f80937","schemeName":"VISA","pan":"4242424242424242","pin":"1234","cvv1":"123","icvv":"456","cvv2":"789","expiration":[2029,7],"sequenceNumber":1,"profileId":2,"userId":5,"cardStatus":"ACTIVE","country":"SG","currencies":["SGD"]},"pos":{"type":"CHIP_AND_PIN","acceptsOnlinePins":true,"maxPinLength":12,"supports3ds":false,"hasChip":true},"transactionStartTime":1667541087.0476434,"stan":"363054","schemeTransactionId":"932290252416153","retrievalReferenceNum":"230805363054"},"requestMti":"0200","authorizationIdResponse":"123646"}},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/requestBody/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example":{"value":{"reference":{"transaction":{"acquirer":{"institutionId":"430010","name":"ACQUIRER NAME","city":"CITY NAME","merchantCategoryCode":5499,"country":"GB","acceptorTerminalId":"TERMID01","acceptorIdCode":"CARD ACCEPTOR","forwardingInstitutionId":"400050"},"card":{"token":"59123122-223d-45f9-b840-0ad4a4f80937","schemeName":"VISA","pan":"4242424242424242","pin":"1234","cvv1":"123","icvv":"456","cvv2":"789","expiration":[2029,7],"sequenceNumber":1,"profileId":2,"userId":5,"cardStatus":"ACTIVE","country":"SG","currencies":["SGD"]},"pos":{"type":"CHIP_AND_PIN","acceptsOnlinePins":true,"maxPinLength":12,"supports3ds":false,"hasChip":true},"transactionStartTime":1667541087.0476434,"stan":"363054","schemeTransactionId":"932290252416153","retrievalReferenceNum":"230805363054"},"requestMti":"0200","authorizationIdResponse":"123646"},"error":null},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1clearing/post/responses/200/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example":{"value":{"amount":{"value":3,"currency":"SGD"},"transactionType":"GOODS_AND_SERVICES","ref":{"transaction":{"acquirer":{"institutionId":"430010","name":"ACQUIRER NAME","city":"CITY NAME","merchantCategoryCode":5499,"country":"GB","acceptorTerminalId":"TERMID01","acceptorIdCode":"CARD ACCEPTOR","forwardingInstitutionId":"400050"},"card":{"token":"59123122-223d-45f9-b840-0ad4a4f80937","schemeName":"VISA","pan":"4242424242424242","pin":"1234","cvv1":"123","icvv":"456","cvv2":"789","expiration":[2029,7],"sequenceNumber":1,"profileId":2,"userId":5,"cardStatus":"ACTIVE","country":"SG","currencies":["SGD"]},"pos":{"type":"CHIP_AND_PIN","acceptsOnlinePins":true,"maxPinLength":12,"supports3ds":false,"hasChip":true},"transactionStartTime":1667541087.0476434,"stan":"363054","schemeTransactionId":"932290252416153","retrievalReferenceNum":"230805363054"},"requestMti":"0200","authorizationIdResponse":"123646"}},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/requestBody/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example":{"value":{"reference":{"transaction":{"acquirer":{"institutionId":"430010","name":"ACQUIRER NAME","city":"CITY NAME","merchantCategoryCode":5499,"country":"GB","acceptorTerminalId":"TERMID01","acceptorIdCode":"CARD ACCEPTOR","forwardingInstitutionId":"400050"},"card":{"token":"59123122-223d-45f9-b840-0ad4a4f80937","schemeName":"VISA","pan":"4242424242424242","pin":"1234","cvv1":"123","icvv":"456","cvv2":"789","expiration":[2029,7],"sequenceNumber":1,"profileId":2,"userId":5,"cardStatus":"ACTIVE","country":"SG","currencies":["SGD"]},"pos":{"type":"CHIP_AND_PIN","acceptsOnlinePins":true,"maxPinLength":12,"supports3ds":false,"hasChip":true},"transactionStartTime":1667541087.0476434,"stan":"363054","schemeTransactionId":"932290252416153","retrievalReferenceNum":"230805363054"},"requestMti":"0200","authorizationIdResponse":"123646"},"error":null},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions~1reversal/post/responses/200/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example":{"value":[{"transactionId":5028,"creationTime":1723600773.748887},{"transactionId":5027,"creationTime":1723600659.095692},{"transactionId":5026,"creationTime":1723600648.133955},{"transactionId":5025,"creationTime":1723545470.449374},{"transactionId":5024,"creationTime":1723545430.790566}],"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1transactions/get/responses/200/content/application~1json/example"},"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example":{"value":{"status":"PRODUCTION_ERROR","errorCode":"PRT_NOT_REACHABLE"},"id":"paths/~1simulation~1spend~1profiles~1{profileId}~1cards~1{cardToken}~1production/post/requestBody/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example":{"value":{"requirements":[{"key":"ID_DOCUMENT_WITH_LIVENESS","state":"IN_REVIEW","description":null}]},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/200/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example":{"value":{"code":"kyc_review.not_found","category":"CLIENT","description":"KycReview not found","details":null},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements/get/responses/404/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example":{"value":{"code":"invalid-request","category":"CLIENT","description":"Profile 123L is a personal type, not permitted to simulate evidence request","details":null},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1add/post/responses/400/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example":{"value":{"requirement":"ACCOUNT_PURPOSE"},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/requestBody/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example":{"value":{"code":"invalid-request","category":"CLIENT","description":"Invalid request. KycRequirement {ACCOUNT_PURPOSE} was not found for KycReview","details":null},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1requirements~1submit/post/responses/400/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example":{"value":{"requestedAction":"APPROVE","requirements":["ACCOUNT_PURPOSE_V2"]},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/requestBody/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example":{"value":{"code":"kyc_review.state_update_not_allowed","category":"CLIENT","description":"Invalid action passed in request, action: APPROVED","details":null},"id":"paths/~1simulation~1profiles~1{profileId}~1kyc-reviews~1{kycReviewId}~1verify/post/responses/400/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest":{"value":{"currency":"USD","amount":2000},"key":"minimalRequest","summary":"Minimal example","id":"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/minimalRequest"},"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest":{"value":{"currency":"USD","amount":2000,"reference":"Test transfer","senderName":"John Doe","senderBankCode":"101019628","senderAccountNumber":"1234567890","senderAddress":{"addressFirstLine":"1 Sender Street","city":"Berlin","postalCode":"10115","stateCode":"BE","country":"DE"},"beneficiaryName":"John Doe","beneficiaryAddress":{"addressFirstLine":"1 Recipient Street","city":"Brussels","postalCode":"1000","stateCode":"BRU","country":"BE"}},"key":"fullRequest","summary":"Full example","id":"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/requestBody/content/application~1json/examples/fullRequest"},"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example":{"value":{"code":"not.valid","message":"No account details found for profile currency pair"},"id":"paths/~1simulation~1profiles~1{profileId}~1bank-transactions~1import/post/responses/400/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal":{"value":{"currencyCode":"EUR","amount":100},"key":"minimal","summary":"Minimal request","id":"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/minimal"},"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full":{"value":{"currencyCode":"EUR","amount":100,"instructedCurrencyCode":"EUR","instructedAmount":101,"beneficiaryName":"John Doe","beneficiaryAccount":"8599680548","beneficiaryAddress":{"addressLine":"1234 Elm St, IL","city":"Springfield","postalCode":"62704","country":"US"},"senderName":"Jane Doe","senderBank":{"bic":"DEUTDEDBFRA","name":"Example Bank","lei":"5493001KJTIIGC8Y1R12","clearingSystemCode":"DEBLZ","clearingSystemMemberId":"50070010","address":{"addressLine":"1 Bank Street","city":"Frankfurt","postalCode":"60311","country":"DE"}},"senderAccount":"DE89370400440532013000","senderAddress":{"addressLine":"5678 Oak St","city":"Springfield","postalCode":"62704","country":"US"},"paymentReference":"Test123","charges":[{"amount":1,"currency":"EUR","agent":"DEUTDEDBFRA"}],"previousInstructingAgents":["COBADEFFXXX"]},"key":"full","summary":"Full request","id":"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/requestBody/content/application~1json/examples/full"},"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example":{"value":{"id":123,"messageReference":null,"mur":null,"uetr":"f87c3c37-d97b-4da6-a788-94004414e648","messageType":"pacs.008.001.08","sender":null,"receiver":null,"state":"RECEIVED","direction":"INCOMING","jsonMessage":null,"finMessage":null,"processTime":"2026-02-27T09:24:38.484276Z","amount":100,"currency":"EUR","valueDate":null,"payoutInstructionId":null,"transferId":null,"actor":"SYSTEM","actorId":null,"actorOktaId":null,"source":"SWIFT_CLOUD","attributes":null,"ackMessage":false},"id":"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/200/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example":{"value":{"errors":[{"arguments":[],"code":"not.valid","message":"must be greater than 0","path":"amount"}]},"id":"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/400/content/application~1json/example"},"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example":{"value":{"arguments":[],"code":"not.valid","message":"None of connected BICs match beneficiary account DE00000000000000000000 (TESTDE00)"},"id":"paths/~1simulation~1profiles~1{profileId}~1swift-in/post/responses/422/content/application~1json/example"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved":{"value":{"id":485,"profileId":220002553,"type":"SANCTIONS","subType":"REFERENCE_SANCTION_HIT","status":"RESOLVED","externalId":null,"createdAt":"2026-07-29T16:06:06.003","updatedAt":"2026-07-29T16:09:32.998","reference":{"type":"TRANSFER","referenceId":"2147513101"},"messages":[{"id":"67631430-77fd-4bbb-a8e0-fdfa67563d66","caseId":485,"createdAt":"2026-07-29T16:06:06.014","content":{"attributes":{"business":{"name":{"type":"String","required":true},"address":{"type":"Address","required":true},"natureOfBusiness":{"type":"String","required":false},"website":{"type":"String","required":false}},"vessel":{"imoNumber":{"type":"String","required":true}},"other":{"explanation":{"type":"String","required":true}},"individual":{"name":{"type":"String","required":true},"dob":{"type":"LocalDate","required":false},"countryOfResidenceIso3":{"type":"String","required":false},"nationality":{"type":"String","required":false}}}},"type":"REFERENCE_SANCTION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"8c08894d-1e62-45c4-8332-cd1565916273","caseId":485,"createdAt":"2026-07-29T16:08:14.308","content":{"submissionData":{"individual":{"name":"Mr. Robert Downy Junior","countryOfResidenceIso3":"GBR"}}},"type":"REFERENCE_SANCTION_HIT_SUBMISSION","author":"PARTNER"}]},"key":"referenceSanctionHitResolved","summary":"REFERENCE_SANCTION_HIT - Resolved case","description":"Real example showing request attributes and partner submission","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitResolved"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney":{"value":{"id":12345001,"profileId":987654321,"type":"SANCTIONS","subType":"DEPOSIT_SANCTION_HIT","status":"IN_REVIEW","externalId":"PARTNER-DEPOSIT-001","createdAt":"2026-07-25T10:00:00.000","updatedAt":"2026-07-27T14:30:00.000","reference":{"type":"TRANSFER","referenceId":"111222333"},"messages":[{"id":"11111111-1111-1111-1111-111111111111","caseId":12345001,"createdAt":"2026-07-25T10:00:00.000","content":{"attributes":{"individual":{"name":{"type":"String","required":true},"dob":{"type":"LocalDate","required":false}},"business":{"name":{"type":"String","required":true},"address":{"type":"Address","required":true},"natureOfBusiness":{"type":"String","required":false},"website":{"type":"String","required":false}}}},"type":"DEPOSIT_SANCTION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"22222222-2222-2222-2222-222222222222","caseId":12345001,"createdAt":"2026-07-25T14:00:00.000","content":{"submissionData":{"individual":{"name":"John Doe","dob":"1985-03-15"}}},"type":"DEPOSIT_SANCTION_HIT_SUBMISSION","author":"PARTNER"},{"id":"33333333-3333-3333-3333-333333333333","caseId":12345001,"createdAt":"2026-07-26T09:00:00.000","content":{"text":{"freeText":"Thank you for the submission. We have reviewed the information and require additional documentation to verify the individual's identity."}},"type":"FREEFORM","author":"WISE_AGENT"},{"id":"44444444-4444-4444-4444-444444444444","caseId":12345001,"createdAt":"2026-07-27T14:30:00.000","content":{"text":{"freeText":"Please find the requested identity documents attached. The individual is a verified customer since 2020."}},"type":"FREEFORM","author":"PARTNER"}]},"key":"depositSanctionHitJourney","summary":"DEPOSIT_SANCTION_HIT - Complete message journey","description":"Shows request, submission, and freeform conversation","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/depositSanctionHitJourney"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney":{"value":{"id":12345002,"profileId":987654322,"type":"SANCTIONS","subType":"RECIPIENT_SANCTION_HIT","status":"IN_REVIEW","externalId":"PARTNER-RECIPIENT-001","createdAt":"2026-07-24T08:00:00.000","updatedAt":"2026-07-26T11:00:00.000","reference":{"type":"TRANSFER","referenceId":"222333444"},"messages":[{"id":"55555555-5555-5555-5555-555555555555","caseId":12345002,"createdAt":"2026-07-24T08:00:00.000","content":{"attributes":{"individual":{"name":{"type":"String","required":true},"countryOfResidenceIso3":{"type":"String","required":true},"dob":{"type":"LocalDate","required":false},"nationality":{"type":"String","required":false}},"business":{"name":{"type":"String","required":true},"address":{"type":"Address","required":true},"natureOfBusiness":{"type":"String","required":false},"website":{"type":"String","required":false}}}},"type":"RECIPIENT_SANCTION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"66666666-6666-6666-6666-666666666666","caseId":12345002,"createdAt":"2026-07-24T15:00:00.000","content":{"submissionData":{"individual":{"name":"Jane Smith","countryOfResidenceIso3":"USA","dob":"1990-07-22","nationality":"American"}}},"type":"RECIPIENT_SANCTION_HIT_SUBMISSION","author":"PARTNER"},{"id":"77777777-7777-7777-7777-777777777777","caseId":12345002,"createdAt":"2026-07-25T10:00:00.000","content":{"text":{"freeText":"We need to verify the recipient's address. Please provide proof of address."}},"type":"FREEFORM","author":"WISE_AGENT"},{"id":"88888888-8888-8888-8888-888888888888","caseId":12345002,"createdAt":"2026-07-26T11:00:00.000","content":{"text":{"freeText":"Attached is the utility bill showing the recipient's address in New York, USA."}},"type":"FREEFORM","author":"PARTNER"}]},"key":"recipientSanctionHitJourney","summary":"RECIPIENT_SANCTION_HIT - Complete message journey","description":"Shows individual submission with required countryOfResidenceIso3","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientSanctionHitJourney"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney":{"value":{"id":12345003,"profileId":987654323,"type":"SANCTIONS","subType":"REFERENCE_SANCTION_HIT","status":"RESOLVED","externalId":null,"createdAt":"2026-07-20T09:00:00.000","updatedAt":"2026-07-23T16:00:00.000","reference":{"type":"TRANSFER","referenceId":"333444555"},"messages":[{"id":"99999999-9999-9999-9999-999999999999","caseId":12345003,"createdAt":"2026-07-20T09:00:00.000","content":{"attributes":{"individual":{"name":{"type":"String","required":true},"dob":{"type":"LocalDate","required":false},"countryOfResidenceIso3":{"type":"String","required":false},"nationality":{"type":"String","required":false}},"business":{"name":{"type":"String","required":true},"address":{"type":"Address","required":true},"natureOfBusiness":{"type":"String","required":false},"website":{"type":"String","required":false}},"vessel":{"imoNumber":{"type":"String","required":true}},"other":{"explanation":{"type":"String","required":true}}}},"type":"REFERENCE_SANCTION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa","caseId":12345003,"createdAt":"2026-07-20T14:00:00.000","content":{"submissionData":{"vessel":{"vesselImoNumber":"9074729"}}},"type":"REFERENCE_SANCTION_HIT_SUBMISSION","author":"PARTNER"},{"id":"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb","caseId":12345003,"createdAt":"2026-07-22T10:00:00.000","content":{"text":{"freeText":"We have verified the vessel IMO number. The vessel is not on any sanctions list. The case has been resolved."}},"type":"FREEFORM","author":"WISE_AGENT"}]},"key":"referenceSanctionHitVesselJourney","summary":"REFERENCE_SANCTION_HIT - Vessel submission","description":"Shows vessel submission for reference sanction hit","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceSanctionHitVesselJourney"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney":{"value":{"id":12345004,"profileId":987654324,"type":"SANCTIONS","subType":"REFERENCE_LOCATION_HIT","status":"WAITING_CUSTOMER_INPUT","externalId":"PARTNER-REF-LOC-001","createdAt":"2026-07-26T07:00:00.000","updatedAt":"2026-07-28T09:00:00.000","reference":{"type":"TRANSFER","referenceId":"444555666"},"messages":[{"id":"dddddddd-dddd-dddd-dddd-dddddddddddd","caseId":12345004,"createdAt":"2026-07-26T07:00:00.000","content":{"attributes":{"other":{"relatedToLocation":{"type":"String","required":true},"paymentExplanation":{"type":"String","required":true},"location":{"type":"String","required":true},"referenceDescription":{"type":"String","required":true}}}},"type":"REFERENCE_LOCATION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee","caseId":12345004,"createdAt":"2026-07-26T12:00:00.000","content":{"submissionData":{"other":{"relatedToLocation":"Payment reference mentions a supplier in Belarus.","paymentExplanation":"Payment for agricultural equipment parts.","location":"Minsk, Belarus","referenceDescription":"Invoice INV-2026-001 for tractor parts."}}},"type":"REFERENCE_LOCATION_HIT_SUBMISSION","author":"PARTNER"},{"id":"ffffffff-ffff-ffff-ffff-ffffffffffff","caseId":12345004,"createdAt":"2026-07-28T09:00:00.000","content":{"text":{"freeText":"Please provide the original invoice and shipping documentation for verification."}},"type":"FREEFORM","author":"WISE_AGENT"}]},"key":"referenceLocationHitJourney","summary":"REFERENCE_LOCATION_HIT - Complete message journey","description":"Shows location submission for reference location hit","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/referenceLocationHitJourney"},"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney":{"value":{"id":12345005,"profileId":987654325,"type":"SANCTIONS","subType":"RECIPIENT_LOCATION_HIT","status":"IN_REVIEW","externalId":"PARTNER-REC-LOC-001","createdAt":"2026-07-27T06:00:00.000","updatedAt":"2026-07-28T15:00:00.000","reference":{"type":"TRANSFER","referenceId":"555666777"},"messages":[{"id":"11112222-3333-4444-5555-666677778888","caseId":12345005,"createdAt":"2026-07-27T06:00:00.000","content":{"attributes":{"other":{"relatedToLocation":{"type":"String","required":true},"paymentExplanation":{"type":"String","required":true},"location":{"type":"String","required":true},"businessWebsite":{"type":"String","required":false}}}},"type":"RECIPIENT_LOCATION_HIT_REQUEST","author":"WISE_SYSTEM"},{"id":"22223333-4444-5555-6666-777788889999","caseId":12345005,"createdAt":"2026-07-27T11:00:00.000","content":{"submissionData":{"other":{"relatedToLocation":"Recipient has a branch office in the flagged location.","paymentExplanation":"Payment for software development services.","location":"Moscow, Russia","businessWebsite":"https://www.techcorp-global.com"}}},"type":"RECIPIENT_LOCATION_HIT_SUBMISSION","author":"PARTNER"},{"id":"33334444-5555-6666-7777-888899990000","caseId":12345005,"createdAt":"2026-07-28T10:00:00.000","content":{"text":{"freeText":"Thank you for the information. Can you confirm that the services were rendered outside of Russia and provide the contract details?"}},"type":"FREEFORM","author":"WISE_AGENT"},{"id":"44445555-6666-7777-8888-999900001111","caseId":12345005,"createdAt":"2026-07-28T15:00:00.000","content":{"text":{"freeText":"Confirmed. The development work was performed by the London office. Contract attached showing UK delivery address."}},"type":"FREEFORM","author":"PARTNER"}]},"key":"recipientLocationHitJourney","summary":"RECIPIENT_LOCATION_HIT - Complete message journey","description":"Shows location submission for recipient location hit","id":"paths/~1cases~1{caseId}/get/responses/200/content/application~1json/examples/recipientLocationHitJourney"},"paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example":{"value":{"error":"BAD_REQUEST","message":"Invalid request body","errors":[{"field":"type","message":"must not be null"}]},"id":"paths/~1cases~1{caseId}/get/responses/400/content/application~1json/example"},"paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example":{"value":{"error":"UNAUTHORIZED","message":"Authentication required"},"id":"paths/~1cases~1{caseId}/get/responses/401/content/application~1json/example"},"paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example":{"value":{"error":"FORBIDDEN","message":"Insufficient permissions to access this resource"},"id":"paths/~1cases~1{caseId}/get/responses/403/content/application~1json/example"},"paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example":{"value":{"error":"NOT_FOUND","message":"Case not found"},"id":"paths/~1cases~1{caseId}/get/responses/404/content/application~1json/example"},"paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform":{"value":{"type":"FREEFORM","submissionData":{"freeText":"The transfer has been verified and approved by our compliance team."}},"key":"freeform","summary":"FREEFORM","description":"Free text message submission","id":"paths/~1cases~1{caseId}~1messages/post/requestBody/content/application~1json/examples/freeform"},"paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse":{"value":{"id":"660e8400-e29b-41d4-a716-446655440001","caseId":12345678,"createdAt":"2026-07-27T15:00:00.000","content":{"text":{"freeText":"The transfer has been verified and approved by our compliance team."}},"type":"FREEFORM","author":"PARTNER"},"key":"freeformResponse","summary":"FREEFORM message created","id":"paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/freeformResponse"},"paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse":{"value":{"id":"770e8400-e29b-41d4-a716-446655440002","caseId":12345678,"createdAt":"2026-07-27T15:05:00.000","content":{"submissionData":{"individual":{"name":"John Doe","dob":"15/03/1985","nationality":"British"}}},"type":"DEPOSIT_SANCTION_HIT_SUBMISSION","author":"PARTNER"},"key":"sanctionHitResponse","summary":"Sanction hit submission created","id":"paths/~1cases~1{caseId}~1messages/post/responses/201/content/application~1json/examples/sanctionHitResponse"},"paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example":{"value":{"error":"BAD_REQUEST","message":"Invalid request body","errors":[{"field":"type","message":"must not be null"}]},"id":"paths/~1cases~1{caseId}~1messages/post/responses/400/content/application~1json/example"},"paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example":{"value":{"error":"UNAUTHORIZED","message":"Authentication required"},"id":"paths/~1cases~1{caseId}~1messages/post/responses/401/content/application~1json/example"},"paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example":{"value":{"error":"FORBIDDEN","message":"Insufficient permissions to access this resource"},"id":"paths/~1cases~1{caseId}~1messages/post/responses/403/content/application~1json/example"},"paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example":{"value":{"error":"NOT_FOUND","message":"Case not found"},"id":"paths/~1cases~1{caseId}~1messages/post/responses/404/content/application~1json/example"},"paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example":{"value":{"error":"NOT_FOUND","message":"Case not found"},"id":"paths/~1cases~1{caseId}~1messages/post/responses/422/content/application~1json/example"},"paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id":{"value":{"identifierType":"TRANSFER_ID","identifier":"16521632"},"key":"lookup-by-transfer-id","summary":"Look up GPI tracking by transfer ID","id":"paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-transfer-id"},"paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr":{"value":{"identifierType":"UETR","identifier":"97ed4827-7b6f-4491-a206-42bcf859a919"},"key":"lookup-by-uetr","summary":"Look up GPI tracking by UETR","id":"paths/~1gpi-tracking/post/requestBody/content/application~1json/examples/lookup-by-uetr"},"paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found":{"value":{"transactions":[{"uetr":"97ed4827-7b6f-4491-a206-42bcf859a919","status":"ACSP","cancellationStatus":"CANCELLATION_REJECTED","initiatedAt":"2023-09-18T12:05:50Z","lastUpdatedAt":"2023-09-18T12:13:33.314Z","events":[{"status":"ACSP","statusReason":{"code":"G001","settlementMethod":{"code":"INGA"},"instructedAgent":"LHVBEE22XXX","chargeBearer":"SHAR"},"statusTime":"2023-09-18T12:13:33.314Z","amountInconsistency":false,"eventType":"CANCELLATION_RESPONSE","eventTarget":"CREDIT_TRANSFER","eventCreationTime":"2023-09-18T12:13:33.348Z"}]}]},"key":"tracking-found","summary":"GPI tracking data found","id":"paths/~1gpi-tracking/post/responses/200/content/application~1json/examples/tracking-found"}},"securitySchemeStore":{"UserToken":{"id":"UserToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Access Token for making API calls on behalf of a Wise user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be obtained via two OAuth 2.0 flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"registration_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners creating users via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization_code grant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": For partners using Wise's authorization page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens are valid for 12 hours and can be refreshed using a refresh token."},"children":[]}]}]}]},"PersonalToken":{"id":"PersonalToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal API Token for individual personal or small business users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generated from Wise.com > Settings > Connect and manage apps > API tokens."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has limited API access compared to OAuth tokens (PSD2 restrictions apply for EU/UK users)."},"children":[]}]}]}]},"ClientCredentialsToken":{"id":"ClientCredentialsToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtained via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with Basic Authentication (client-id:client-secret) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for 12 hours. No refresh token — fetch a new token when expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/oauth-token/oauthtokencreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create an OAuth token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic Authentication using your Client ID and Client Secret as the username and password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials are provided by Wise when your partnership begins. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/developer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"x-defaultUsername":"","x-defaultPassword":""}},"servers":[{"url":"https://api.wise.com/2026Q3","description":"Production Environment"},{"url":"https://api.wise-sandbox.com/2026Q3","description":"Sandbox Environment"}]},"options":{"hideDownloadButtons":false,"hideReplay":true,"hideSchemaTitles":true,"jsonSamplesExpandLevel":3,"schemasExpansionLevel":1,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-reference/@latest/index.json?download"},{"url":"/_bundle/api-reference/@latest/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Wise Platform API","description":"The Wise Platform API is a REST-based interface that enables programmatic access to Wise's payment infrastructure. All endpoints return JSON-formatted responses and use standard HTTP methods and status codes.\n{% admonition type=\"success\" name=\"New to wise?\" %}\n We strongly recommend first reading our **[Getting Started Guide](/guides/developer/index.md)** to help you set up credentials and make your first call.\n{% /admonition %}\n\nBefore you begin {% .title-2 .m-t-5 %}\n\nTo use this API reference effectively, you should have:\n\n- Received Valid [API credentials from Wise](/guides/developer/auth-and-security/index.md) (Client ID and Client Secret)\n- Understand OAuth 2.0 authentication\n- Be familiar with RESTful API concepts\n\nCore API resources {% .title-2 .m-t-5 .m-b-0 %}\n\n| Resource | Purpose |\n|----------|---------|\n| **[Quote](/api-reference/quote)** | Exchange rate and fee calculations |\n| **[Recipient](/api-reference/recipient)** | Beneficiary account management |\n| **[Transfer](/api-reference/transfer)** | Payment creation and execution |\n| **[Balance](/api-reference/balance)** | Multi-currency account operations |\n| **[Profile](/api-reference/profile)** | Account ownership details |\n| **[Rate](/api-reference/rate)** | Current and historical exchange rates |\n\n**Not sure which workflow to build?**
\nStart with our [Integration Guides](/guides/product/send-money/use-cases/index.md) for step-by-step implementation examples.{% .m-t-3 .m-b-5 %}\n"}},"baseSlug":"/api-reference","routesMapping":{}}