{"items":[{"type":"link","label":"Weavr Multi Product API","link":"/products/multi/openapi","routeSlug":"/products/multi/openapi","content":{"contentType":"overview","meta":{"name":"Weavr Multi Product API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/multi/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/multi/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://weavr.io","url":"https://weavr.io"}]},{"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":[{"description":"Weavr Sandbox Environment","url":"https://sandbox.weavr.io/multi"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Weavr Multi Product API (v3)","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":"Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers."},"children":[]}]}]}]}],"sectionId":"/products/multi/openapi"}],"sectionId":"/products/multi/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request to the Multi API must include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that represents your account. You can obtain an API Key by registering for a Multi account "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://portal.weavr.io"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"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":"Almost all endpoints require a secondary authentication token "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that represents the user for whom the request is being executed."},"children":[]}]}]}]}],"sectionId":"/products/multi/openapi/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/products/multi/openapi/section/authentication","routeSlug":"/products/multi/openapi/section/authentication","content":null},{"type":"separator","label":"Customer Registration","content":null},{"type":"group","label":"Corporates","link":"/products/multi/openapi/corporates","routeSlug":"/products/multi/openapi/corporates","items":[{"label":"Register a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatecreate","routeSlug":"/products/multi/openapi/corporates/corporatecreate","metadata":{"seo":{"title":"Register a corporate","description":"Create a corporate identity for a business customer. The information provided must be accurate and will be passed on for KYB verification with our partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateCreate","name":"Register a corporate","isWebhook":false,"pointer":"/paths/~1corporates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a corporate identity for a business customer.  The information provided must be accurate and will be passed on for KYB verification with our partner."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1corporates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360","pointer":"/paths/~1corporates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_360"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/corporates","href":"corporates/corporatecreate","openApiOperationId":"corporateCreate","summary":"Register a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedCorporate"}},"schemaId":"components/schemas/CreatedCorporate","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatedCorporate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatedCorporate"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatecreate"}],"panels":[]}]},"httpPath":"/corporates"},{"label":"Submit known KYB entity data for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybsubmitentity","routeSlug":"/products/multi/openapi/corporates/corporatekybsubmitentity","metadata":{"seo":{"title":"Submit known KYB entity data for the corporate","description":"Submit the company and ownership-graph information you already hold for the corporate, to pre-populate its KYB before the corporate starts their KYB journey. Optional; all fields are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybSubmitEntity","name":"Submit known KYB entity data for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit known KYB entity data for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit the company and ownership-graph information you already hold for the corporate, to\npre-populate its KYB before the corporate starts their KYB journey. Optional; all fields are optional.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorporateKybEntitySubmission"}},"schemaId":"components/schemas/CorporateKybEntitySubmission","pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/{corporateId}/kyb/entity","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CorporateKybEntitySubmission"}},"responseCodes":["201","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/entity","href":"corporates/corporatekybsubmitentity","openApiOperationId":"corporateKybSubmitEntity","summary":"Submit known KYB entity data for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CorporateKybEntitySubmission","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorporateKybEntitySubmission"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Details accepted."},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybsubmitentity"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/entity"},{"label":"Get the submitted KYB entity data for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetentity","routeSlug":"/products/multi/openapi/corporates/corporatekybgetentity","metadata":{"seo":{"title":"Get the submitted KYB entity data for the corporate","description":"Return the company and ownership-graph information submitted to pre-populate the corporate's KYB."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybGetEntity","name":"Get the submitted KYB entity data for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the submitted KYB entity data for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return the company and ownership-graph information submitted to pre-populate the corporate's KYB.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corporates/{corporateId}/kyb/entity","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/entity","href":"corporates/corporatekybgetentity","openApiOperationId":"corporateKybGetEntity","summary":"Get the submitted KYB entity data for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybEntityResponseSchema"}},"schemaId":"components/schemas/CorporateKybEntityResponseSchema","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1entity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorporateKybEntityResponseSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybEntityResponseSchema"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybgetentity"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/entity"},{"label":"Submit the KYB account-usage profile for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybsetprofile","routeSlug":"/products/multi/openapi/corporates/corporatekybsetprofile","metadata":{"seo":{"title":"Submit the KYB account-usage profile for the corporate","description":"Submit the corporate's account-usage profile (funding, collections, withdrawals, payouts, cards) to pre-populate its KYB. Optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybSetProfile","name":"Submit the KYB account-usage profile for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit the KYB account-usage profile for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit the corporate's account-usage profile (funding, collections, withdrawals, payouts, cards)\nto pre-populate its KYB. Optional.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorporateKybProfileSubmission"}},"schemaId":"components/schemas/CorporateKybProfileSubmission","pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/{corporateId}/kyb/profile","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CorporateKybProfileSubmission"}},"responseCodes":["201","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/profile","href":"corporates/corporatekybsetprofile","openApiOperationId":"corporateKybSetProfile","summary":"Submit the KYB account-usage profile for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CorporateKybProfileSubmission","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorporateKybProfileSubmission"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Profile accepted."},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybsetprofile"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/profile"},{"label":"Get the submitted KYB account-usage profile for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetprofile","routeSlug":"/products/multi/openapi/corporates/corporatekybgetprofile","metadata":{"seo":{"title":"Get the submitted KYB account-usage profile for the corporate","description":"Return the account-usage profile submitted to pre-populate the corporate's KYB."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybGetProfile","name":"Get the submitted KYB account-usage profile for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the submitted KYB account-usage profile for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return the account-usage profile submitted to pre-populate the corporate's KYB.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corporates/{corporateId}/kyb/profile","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/profile","href":"corporates/corporatekybgetprofile","openApiOperationId":"corporateKybGetProfile","summary":"Get the submitted KYB account-usage profile for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybProfileResponseSchema"}},"schemaId":"components/schemas/CorporateKybProfileResponseSchema","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1profile/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorporateKybProfileResponseSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybProfileResponseSchema"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybgetprofile"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/profile"},{"label":"Upload a KYB supporting document for the corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybuploaddocument","routeSlug":"/products/multi/openapi/corporates/corporatekybuploaddocument","metadata":{"seo":{"title":"Upload a KYB supporting document for the corporate","description":"Upload a supporting document to pre-populate the corporate's KYB before the corporate starts their KYB journey. Optional; one document per call (up to 10MB)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybUploadDocument","name":"Upload a KYB supporting document for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a KYB supporting document for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload a supporting document to pre-populate the corporate's KYB before the corporate starts\ntheir KYB journey. Optional; one document per call (up to 10MB).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/CorporateKybDocumentForm"}},"schemaId":"components/schemas/CorporateKybDocumentForm","pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/{corporateId}/kyb/documents","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/CorporateKybDocumentForm"}},"responseCodes":["201","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/documents","href":"corporates/corporatekybuploaddocument","openApiOperationId":"corporateKybUploadDocument","summary":"Upload a KYB supporting document for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CorporateKybDocumentForm","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/CorporateKybDocumentForm"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Document accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybDocumentResponse"}},"schemaId":"components/schemas/CorporateKybDocumentResponse"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CorporateKybDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybDocumentResponse"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybuploaddocument"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/documents"},{"label":"List the uploaded KYB documents for the corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/corporates/corporatekybgetdocuments","routeSlug":"/products/multi/openapi/corporates/corporatekybgetdocuments","metadata":{"seo":{"title":"List the uploaded KYB documents for the corporate","description":"List the documents uploaded to pre-populate the corporate's KYB. Returns metadata only, no binaries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybGetDocuments","name":"List the uploaded KYB documents for the corporate","isWebhook":false,"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the uploaded KYB documents for the corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the documents uploaded to pre-populate the corporate's KYB. Returns metadata only, no binaries.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"corporateId","in":"path","schemaId":"schema_366","description":"The corporate this KYB submission belongs to.","required":true}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corporates/{corporateId}/kyb/documents","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"corporateId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/corporates/{corporateId}/kyb/documents","href":"corporates/corporatekybgetdocuments","openApiOperationId":"corporateKybGetDocuments","summary":"List the uploaded KYB documents for the corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybDocumentList"}},"schemaId":"components/schemas/CorporateKybDocumentList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1{corporateId}~1kyb~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorporateKybDocumentList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorporateKybDocumentList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporatekybgetdocuments"}],"panels":[]}]},"httpPath":"/corporates/{corporateId}/kyb/documents"}],"content":{"contentType":"group","meta":{"name":"Corporates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporates","showPageActions":true},{"nodeType":"markdoc","content":"Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/corporates","summary":"Register a corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporatecreate","deprecated":false},{"title":"/corporates/{corporateId}/kyb/entity","summary":"Submit known KYB entity data for the corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporatekybsubmitentity","deprecated":false},{"title":"/corporates/{corporateId}/kyb/entity","summary":"Get the submitted KYB entity data for the corporate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/corporates/corporatekybgetentity","deprecated":false},{"title":"/corporates/{corporateId}/kyb/profile","summary":"Submit the KYB account-usage profile for the corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporatekybsetprofile","deprecated":false},{"title":"/corporates/{corporateId}/kyb/profile","summary":"Get the submitted KYB account-usage profile for the corporate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/corporates/corporatekybgetprofile","deprecated":false},{"title":"/corporates/{corporateId}/kyb/documents","summary":"Upload a KYB supporting document for the corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporatekybuploaddocument","deprecated":false},{"title":"/corporates/{corporateId}/kyb/documents","summary":"List the uploaded KYB documents for the corporate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/corporates/corporatekybgetdocuments","deprecated":false}]}]}]}]}},{"type":"group","label":"Consumers","link":"/products/multi/openapi/consumers","routeSlug":"/products/multi/openapi/consumers","items":[{"label":"Register a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/consumers/consumercreate","routeSlug":"/products/multi/openapi/consumers/consumercreate","metadata":{"seo":{"title":"Register a consumer","description":"Create a Consumer Identity to represent an Individual."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerCreate","name":"Register a consumer","isWebhook":false,"pointer":"/paths/~1consumers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a consumer","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 Consumer Identity to represent an Individual."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information provided must be accurate as it will be passed on for KYC verification with our partner."},"children":[]}]}]},{"$$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":"Incorrect information may incur a re-processing fee."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1consumers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371","pointer":"/paths/~1consumers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/consumers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_371"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/consumers","href":"consumers/consumercreate","openApiOperationId":"consumerCreate","summary":"Register a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}},"schemaId":"components/schemas/Consumer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Consumer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/consumercreate"}],"panels":[]}]},"httpPath":"/consumers"}],"content":{"contentType":"group","meta":{"name":"Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumers","showPageActions":true},{"nodeType":"markdoc","content":"Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/consumers","summary":"Register a consumer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumers/consumercreate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Users & User Authentication","content":null},{"type":"group","label":"Setup","link":"/products/multi/openapi/setup","routeSlug":"/products/multi/openapi/setup","items":[{"label":"Register a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usercreate","routeSlug":"/products/multi/openapi/setup/usercreate","metadata":{"seo":{"title":"Register a user","description":"Creates a user linked to the logged-in corporate or consumer identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userCreate","name":"Register a user","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register a user","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 user linked to the logged-in corporate or consumer identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once on-boarded, users have access to all instruments (cards and accounts) of the identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application-specific permissions to limit what each user can view and do need to be implemented in your application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to Create an Authorised User you would need a stepped-up token. Before calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/multi/users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you need to step-up ( issue a challenge "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multi/stepup/challenges/otp/{channel}"},"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":"More details on how to step-up a token can be found here "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Step-up-Challenges/operation/stepupSCAChallenge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-Up"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_373"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/users","href":"setup/usercreate","openApiOperationId":"userCreate","summary":"Register a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users/post/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":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/usercreate"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usersget","routeSlug":"/products/multi/openapi/setup/usersget","metadata":{"seo":{"title":"Get all users","description":"Fetches all users associated with the corporate or consumer identity the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"usersGet","name":"Get all users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches all users associated with the corporate or consumer identity the logged-in user belongs to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"active","in":"query","schemaId":"schema_378","description":"Filter for active or deactivated users. Leave out to fetch all users."},{"name":"email","in":"query","schemaId":"schema_379","description":"Filter by the email address of the user."},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card."},{"name":"roles","in":"query","schemaId":"schema_380","description":"Filter users by role. Multiple roles use OR logic."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"active","in":"query","required":false,"schemaId":"schema_378"},{"name":"email","in":"query","required":false,"schemaId":"components/schemas/Email"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"},{"name":"roles","in":"query","required":false,"schemaId":"schema_380","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/users","href":"setup/usersget","openApiOperationId":"usersGet","summary":"Get all users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/usersget"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/usergetbyid","routeSlug":"/products/multi/openapi/setup/usergetbyid","metadata":{"seo":{"title":"Get a user","description":"Retrieves the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userGetById","name":"Get a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user","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 identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/users/{user_id}","href":"setup/usergetbyid","openApiOperationId":"userGetById","summary":"Get a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}/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":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/usergetbyid"}],"panels":[]}]},"httpPath":"/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userupdate","routeSlug":"/products/multi/openapi/setup/userupdate","metadata":{"seo":{"title":"Update a user","description":"Update the details of a user identified by the user_id in the the path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userUpdate","name":"Update a user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","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 details of a user identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the the path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the fields that are specified in the request body will be updated. All other fields will remain unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When patching a mobile number, the new mobile number should be enrolled for Authentication Factors."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users~1{user_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383","pointer":"/paths/~1users~1{user_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/users/{user_id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_383"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/users/{user_id}","href":"setup/userupdate","openApiOperationId":"userUpdate","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}/patch/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":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/userupdate"}],"panels":[]}]},"httpPath":"/users/{user_id}"},{"label":"Get linked identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/useridentities","routeSlug":"/products/multi/openapi/setup/useridentities","metadata":{"seo":{"title":"Get linked identities","description":"Retrieves a list of identities available to the holder of the token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userIdentities","name":"Get linked identities","isWebhook":false,"pointer":"/paths/~1identities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get linked identities","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 identities available to the holder of the token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]},{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_385","description":"The number of results to skip from the beginning of the dataset."},{"name":"limit","in":"query","schemaId":"schema_386","description":"The maximum number of identities to return."}],"pointer":"/paths/~1identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identities","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_385"},{"name":"limit","in":"query","required":false,"schemaId":"schema_386"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500","503","default"],"pointer":"/identities","href":"setup/useridentities","openApiOperationId":"userIdentities","summary":"Get linked identities","securityGroups":[{"auth_token":[],"api-key":[]},{"api-key":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserIdentitiesGetResponseSchema"}},"schemaId":"components/schemas/UserIdentitiesGetResponseSchema","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1identities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserIdentitiesGetResponseSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserIdentitiesGetResponseSchema"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/useridentities"}],"panels":[]}]},"httpPath":"/identities"},{"label":"Invite a user to set a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinvitesend","routeSlug":"/products/multi/openapi/setup/userinvitesend","metadata":{"seo":{"title":"Invite a user to set a password","description":"Sends an invitation to a user to join your identity. Once a user is created using the userCreate operation, an invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the userInviteConsume."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userInviteSend","name":"Invite a user to set a password","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1invite/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invite a user to set a password","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 an invitation to a user to join your identity. Once a user is created using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userCreate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, an invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userInviteConsume"},"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":"To give a user that already exists on another identity access to your identity, use "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userLink"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1invite/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users~1{user_id}~1invite/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/invite","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/users/{user_id}/invite","href":"setup/userinvitesend","openApiOperationId":"userInviteSend","summary":"Invite a user to set a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/userinvitesend"}],"panels":[]}]},"httpPath":"/users/{user_id}/invite"},{"label":"Validate a user's invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinvitevalidate","routeSlug":"/products/multi/openapi/setup/userinvitevalidate","metadata":{"seo":{"title":"Validate a user's invite","description":"Check if a user's invite is still valid. This operation is useful to avoid having the user fill in a form only to be held by a validation issue (eg. expired invite)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userInviteValidate","name":"Validate a user's invite","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1invite~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a user's invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check if a user's invite is still valid. This operation is useful to avoid having the user fill in a form only to be held by a validation issue (eg. expired invite)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1invite~1validate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/~1users~1{user_id}~1invite~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/invite/validate","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/users/{user_id}/invite/validate","href":"setup/userinvitevalidate","openApiOperationId":"userInviteValidate","summary":"Validate a user's invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1invite~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/userinvitevalidate"}],"panels":[]}]},"httpPath":"/users/{user_id}/invite/validate"},{"label":"Consume a user's invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/userinviteconsume","routeSlug":"/products/multi/openapi/setup/userinviteconsume","metadata":{"seo":{"title":"Consume a user's invite","description":"Consumes an invitation perviously sent to the user via userInviteSend. This is needed so that the invited user sets up the password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userInviteConsume","name":"Consume a user's invite","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1invite~1consume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consume a user's invite","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":"Consumes an invitation perviously sent to the user via "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userInviteSend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is needed so that the invited user sets up the password."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inviteCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1invite~1consume/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users~1{user_id}~1invite~1consume/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391","pointer":"/paths/~1users~1{user_id}~1invite~1consume/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/invite/consume","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_391"}},"responseCodes":["200","400","401","403","404","409","410","429","500","503","default"],"pointer":"/users/{user_id}/invite/consume","href":"setup/userinviteconsume","openApiOperationId":"userInviteConsume","summary":"Consume a user's invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}},"schemaId":"components/schemas/TokenResponse","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1invite~1consume/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/userinviteconsume"}],"panels":[]}]},"httpPath":"/users/{user_id}/invite/consume"},{"label":"Send an email verification code to a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/authoriseduseremailverificationcodesend","routeSlug":"/products/multi/openapi/setup/authoriseduseremailverificationcodesend","metadata":{"seo":{"title":"Send an email verification code to a user","description":"The first step in verifying an authorised user's email. The authorised user whose email address is to be verified is sent an email containing a randomly generated code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorisedUserEmailVerificationCodeSend","name":"Send an email verification code to a user","isWebhook":false,"pointer":"/paths/~1users~1verification~1email~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an email verification code to a user","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 first step in verifying an authorised user's email. The authorised user whose email address is to be verified is sent an email containing a randomly generated code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code must then be provided in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisedUserEmailVerify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to verify the authorised user's email address."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users~1verification~1email~1send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","pointer":"/paths/~1users~1verification~1email~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/verification/email/send","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_393"}},"responseCodes":["204","400","401","404","409","429","500","503","default"],"pointer":"/users/verification/email/send","href":"setup/authoriseduseremailverificationcodesend","openApiOperationId":"authorisedUserEmailVerificationCodeSend","summary":"Send an email verification code to a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_394"}},"schemaId":"schema_394"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1verification~1email~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_394","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_394"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/authoriseduseremailverificationcodesend"}],"panels":[]}]},"httpPath":"/users/verification/email/send"},{"label":"Verify email of the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/setup/authoriseduseremailverify","routeSlug":"/products/multi/openapi/setup/authoriseduseremailverify","metadata":{"seo":{"title":"Verify email of the authorised user","description":"The second step in verifying the authorised user's email. The randomly generated code sent to the authorised user viaemail, using the authorisedUserEmailVerificationCodeSend operation, is submitted here to verify the authorised user's email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorisedUserEmailVerify","name":"Verify email of the authorised user","isWebhook":false,"pointer":"/paths/~1users~1verification~1email~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify email of the authorised user","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 second step in verifying the authorised user's email. The randomly generated code sent to the authorised user via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email, using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorisedUserEmailVerificationCodeSend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, is submitted here to verify the authorised user's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is needed as part of the verification process for basic due diligence."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/~1users~1verification~1email~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/verification/email/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/users/verification/email/verify","href":"setup/authoriseduseremailverify","openApiOperationId":"authorisedUserEmailVerify","summary":"Verify email of the authorised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1verification~1email~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/setup/authoriseduseremailverify"}],"panels":[]}]},"httpPath":"/users/verification/email/verify"}],"content":{"contentType":"group","meta":{"name":"Setup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Setup","showPageActions":true},{"nodeType":"markdoc","content":"Register and manage the lifecycle of users that can access an identity, including authorised users invited by a Corporate or Consumer root user."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"Register a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/usercreate","deprecated":false},{"title":"/users","summary":"Get all users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/setup/usersget","deprecated":false},{"title":"/users/{user_id}","summary":"Get a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/setup/usergetbyid","deprecated":false},{"title":"/users/{user_id}","summary":"Update a user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/setup/userupdate","deprecated":false},{"title":"/identities","summary":"Get linked identities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/setup/useridentities","deprecated":false},{"title":"/users/{user_id}/invite","summary":"Invite a user to set a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/userinvitesend","deprecated":false},{"title":"/users/{user_id}/invite/validate","summary":"Validate a user's invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/userinvitevalidate","deprecated":false},{"title":"/users/{user_id}/invite/consume","summary":"Consume a user's invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/userinviteconsume","deprecated":false},{"title":"/users/verification/email/send","summary":"Send an email verification code to a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/authoriseduseremailverificationcodesend","deprecated":false},{"title":"/users/verification/email/verify","summary":"Verify email of the authorised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/setup/authoriseduseremailverify","deprecated":false}]}]}]}]}},{"type":"group","label":"Sign-in","link":"/products/multi/openapi/sign-in","routeSlug":"/products/multi/openapi/sign-in","items":[{"label":"Sign in with password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/loginwithpassword","routeSlug":"/products/multi/openapi/sign-in/loginwithpassword","metadata":{"seo":{"title":"Sign in with password","description":"Authenticate a user with the email and password that they provided when registering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"loginWithPassword","name":"Sign in with password","isWebhook":false,"pointer":"/paths/~1login_with_password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sign in with password","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":"Authenticate a user with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that they provided when registering."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Given that the user credentials are correct, this returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can then be used to authorise"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other secured operations. In case the password is expired, a temporary "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned, which can be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"solely for updating the password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token returned is valid for 5 minutes from last activity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397","pointer":"/paths/~1login_with_password/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/login_with_password","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_397"}},"responseCodes":["200","400","401","403","404","409","410","423","429","500","503","default"],"pointer":"/login_with_password","href":"sign-in/loginwithpassword","openApiOperationId":"loginWithPassword","summary":"Sign in with password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_397"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"The authentication credentials are not found or are incorrect."},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's password has expired. Use the returned temporary token to update their password via the  '"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/passwords/update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"' endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"423","description":"Locked - Account is temporarily locked due to failed consecutive login attempts. Try again in 30 minutes.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1login_with_password/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"423"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sign-in/loginwithpassword"}],"panels":[]}]},"httpPath":"/login_with_password"},{"label":"Sign in via biometrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/loginviabiometrics","routeSlug":"/products/multi/openapi/sign-in/loginviabiometrics","metadata":{"seo":{"title":"Sign in via biometrics","description":"Trigger a push notification and subsequent biometric authentication of a user, by providing the email that was used in the enrolment process of biometrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"loginViaBiometrics","name":"Sign in via biometrics","isWebhook":false,"pointer":"/paths/~1login_via_biometrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sign in via biometrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger a push notification and subsequent biometric authentication of a user, by providing the email that was \nused in the enrolment process of biometrics.\n\nThis endpoint can be used in conjunction with your application to authenticate a user and receive a stepped-up \ntoken in a single action, for use in-session for any endpoints or UI components that require step-up \nauthentication.\n\nGiven that the user credentials are correct, a push notification is sent to the user requesting them to complete\nbiometric authentication. On successful completion of authentication, a token will be shared that can be used \nfor endpoints or UI components that require a stepped-up token.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1login_via_biometrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/login_via_biometrics","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","409","423","429","500","503","default"],"pointer":"/login_via_biometrics","href":"sign-in/loginviabiometrics","openApiOperationId":"loginViaBiometrics","summary":"Sign in via biometrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"The authentication credentials are not found or are incorrect."},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402"},{"code":"423","description":"Locked - Account is temporarily locked due to failed consecutive login attempts. Try again in 30 minutes.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1login_via_biometrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}}},{"code":"423"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sign-in/loginviabiometrics"}],"panels":[]}]},"httpPath":"/login_via_biometrics"},{"label":"Logout","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sign-in/logout","routeSlug":"/products/multi/openapi/sign-in/logout","metadata":{"seo":{"title":"Logout","description":"Logs out the user and terminates the session identified by the auth_token in the Authorization Header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logout","name":"Logout","deprecated":true,"isWebhook":false,"pointer":"/paths/~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout","isWebhook":false,"deprecated":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":"Logs out the user and terminates the session identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Authorization Header."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/logout","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","429","500","503","default"],"pointer":"/logout","href":"sign-in/logout","openApiOperationId":"logout","summary":"Logout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1logout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}},{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sign-in/logout"}],"panels":[]}]},"httpPath":"/logout"}],"content":{"contentType":"group","meta":{"name":"Sign-in"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sign-in","showPageActions":true},{"nodeType":"markdoc","content":"Sign users in using passwords, biometrics, or third-party auth providers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/login_with_password","summary":"Sign in with password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sign-in/loginwithpassword","deprecated":false},{"title":"/login_via_biometrics","summary":"Sign in via biometrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sign-in/loginviabiometrics","deprecated":false},{"title":"/logout","summary":"Logout","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/sign-in/logout","deprecated":true}]}]}]}]}},{"type":"group","label":"Step-up Challenges","link":"/products/multi/openapi/step-up-challenges","routeSlug":"/products/multi/openapi/step-up-challenges","items":[{"label":"Issue a one-time password that can be used to step-up a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscachallenge","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to step-up a token","description":"Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through /authentication_factors/otp/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stepupSCAChallenge","name":"Issue a one-time password that can be used to step-up a token","isWebhook":false,"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a one-time password that can be used to step-up a 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":"Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/otp/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This process is required for endpoints that require a step-up token to complete the call."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stepup/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/stepup/challenges/otp/{channel}","href":"step-up-challenges/stepupscachallenge","openApiOperationId":"stepupSCAChallenge","summary":"Issue a one-time password that can be used to step-up a token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-up-challenges/stepupscachallenge"}],"panels":[]}]},"httpPath":"/stepup/challenges/otp/{channel}"},{"label":"Verify a step-up token using a one-time password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscaverify","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscaverify","metadata":{"seo":{"title":"Verify a step-up token using a one-time password","description":"Completes the verification process for a step up token.The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stepupSCAVerify","name":"Verify a step-up token using a one-time password","isWebhook":false,"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a step-up token using a one-time password","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":"Completes the verification process for a step up token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1stepup~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stepup/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/stepup/challenges/otp/{channel}/verify","href":"step-up-challenges/stepupscaverify","openApiOperationId":"stepupSCAVerify","summary":"Verify a step-up token using a one-time password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stepup~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-up-challenges/stepupscaverify"}],"panels":[]}]},"httpPath":"/stepup/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to step-up a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/step-up-challenges/stepupscachallengepush","routeSlug":"/products/multi/openapi/step-up-challenges/stepupscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to step-up a token","description":"Initiates the step-up token process by submitting a push notification to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stepupSCAChallengePush","name":"Issue a push notification that can be used to step-up a token","isWebhook":false,"pointer":"/paths/~1stepup~1challenges~1push~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a push notification that can be used to step-up a 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":"Initiates the step-up token process by submitting a push notification to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/push/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the token step-up isn't already in flight."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1stepup~1challenges~1push~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1stepup~1challenges~1push~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/stepup/challenges/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","405","409","429","500","503","default"],"pointer":"/stepup/challenges/push/{channel}","href":"step-up-challenges/stepupscachallengepush","openApiOperationId":"stepupSCAChallengePush","summary":"Issue a push notification that can be used to step-up a token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1stepup~1challenges~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-up-challenges/stepupscachallengepush"}],"panels":[]}]},"httpPath":"/stepup/challenges/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Step-up Challenges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Step-up Challenges","showPageActions":true},{"nodeType":"markdoc","content":"Issue and verify step-up challenges that elevate an existing user token."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/stepup/challenges/otp/{channel}","summary":"Issue a one-time password that can be used to step-up a token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/step-up-challenges/stepupscachallenge","deprecated":false},{"title":"/stepup/challenges/otp/{channel}/verify","summary":"Verify a step-up token using a one-time password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/step-up-challenges/stepupscaverify","deprecated":false},{"title":"/stepup/challenges/push/{channel}","summary":"Issue a push notification that can be used to step-up a token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/step-up-challenges/stepupscachallengepush","deprecated":false}]}]}]}]}},{"type":"group","label":"Confirmation Challenges","link":"/products/multi/openapi/confirmation-challenges","routeSlug":"/products/multi/openapi/confirmation-challenges","items":[{"label":"Issue a one-time password that can be used to verify a list of resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescachallenge","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify a list of resources","description":"Starts the verification process for a list of resources in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipleSCAChallenge","name":"Issue a one-time password that can be used to verify a list of resources","isWebhook":false,"pointer":"/paths/~1challenges~1otp~1{channel}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a one-time password that can be used to verify a list of resources","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":"Starts the verification process for a list of resources in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/otp/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can be used to challenge "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing Wire Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked Account Declarations"},"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 should only start this process if the operation "},"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":"PENDING_CHALLENGE"},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1challenges~1otp~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1challenges~1otp~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1challenges~1otp~1{channel}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_411"}},"responseCodes":["200","400","401","403","405","409","429","500","503","default"],"pointer":"/challenges/otp/{channel}","href":"confirmation-challenges/multiplescachallenge","openApiOperationId":"multipleSCAChallenge","summary":"Issue a one-time password that can be used to verify a list of resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmation-challenges/multiplescachallenge"}],"panels":[]}]},"httpPath":"/challenges/otp/{channel}"},{"label":"Verify a list of resources using a one-time password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescaverify","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescaverify","metadata":{"seo":{"title":"Verify a list of resources using a one-time password","description":"Completes the verification process for a list of resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipleSCAVerify","name":"Verify a list of resources using a one-time password","isWebhook":false,"pointer":"/paths/~1challenges~1{scaChallengeId}~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a list of resources using a one-time password","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":"Completes the verification process for a list of resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can be used to challenge "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing Wire Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends"},"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 outcome of the verification is successful, the resource is executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not verified challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scaChallengeId","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the SCA challenge.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1challenges~1{scaChallengeId}~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1challenges~1{scaChallengeId}~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414","pointer":"/paths/~1challenges~1{scaChallengeId}~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/challenges/{scaChallengeId}/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"scaChallengeId","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_414"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/challenges/{scaChallengeId}/otp/{channel}/verify","href":"confirmation-challenges/multiplescaverify","openApiOperationId":"multipleSCAVerify","summary":"Verify a list of resources using a one-time password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1challenges~1{scaChallengeId}~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmation-challenges/multiplescaverify"}],"panels":[]}]},"httpPath":"/challenges/{scaChallengeId}/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify a list of resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/confirmation-challenges/multiplescachallengepush","routeSlug":"/products/multi/openapi/confirmation-challenges/multiplescachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify a list of resources","description":"Starts the verification process for a list of resources in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"multipleSCAChallengePush","name":"Issue a push notification that can be used to verify a list of resources","isWebhook":false,"pointer":"/paths/~1challenges~1push~1{channel}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a push notification that can be used to verify a list of resources","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":"Starts the verification process for a list of resources in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/push/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint can be used to challenge "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing Wire Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" & "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends"},"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 should only start this process if the resource "},"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":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1challenges~1push~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1challenges~1push~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1challenges~1push~1{channel}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/challenges/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_411"}},"responseCodes":["200","400","401","403","405","409","429","500","503","default"],"pointer":"/challenges/push/{channel}","href":"confirmation-challenges/multiplescachallengepush","openApiOperationId":"multipleSCAChallengePush","summary":"Issue a push notification that can be used to verify a list of resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1challenges~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/confirmation-challenges/multiplescachallengepush"}],"panels":[]}]},"httpPath":"/challenges/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Confirmation Challenges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirmation Challenges","showPageActions":true},{"nodeType":"markdoc","content":"Issue and verify confirmation challenges used to authorise lists of resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/challenges/otp/{channel}","summary":"Issue a one-time password that can be used to verify a list of resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/confirmation-challenges/multiplescachallenge","deprecated":false},{"title":"/challenges/{scaChallengeId}/otp/{channel}/verify","summary":"Verify a list of resources using a one-time password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/confirmation-challenges/multiplescaverify","deprecated":false},{"title":"/challenges/push/{channel}","summary":"Issue a push notification that can be used to verify a list of resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/confirmation-challenges/multiplescachallengepush","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication Factors","link":"/products/multi/openapi/authentication-factors","routeSlug":"/products/multi/openapi/authentication-factors","items":[{"label":"Create a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordcreate","routeSlug":"/products/multi/openapi/authentication-factors/passwordcreate","metadata":{"seo":{"title":"Create a password","description":"Create a new password for the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"passwordCreate","name":"Create a password","isWebhook":false,"pointer":"/paths/~1passwords~1{user_id}~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a password","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 new password for the user identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1passwords~1{user_id}~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416","pointer":"/paths/~1passwords~1{user_id}~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/passwords/{user_id}/create","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_416"}},"responseCodes":["200","400","401","403","404","409","410","429","500","503","default"],"pointer":"/passwords/{user_id}/create","href":"authentication-factors/passwordcreate","openApiOperationId":"passwordCreate","summary":"Create a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}},"schemaId":"schema_418"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1passwords~1{user_id}~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_418","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/passwordcreate"}],"panels":[]}]},"httpPath":"/passwords/{user_id}/create"},{"label":"Update a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordupdate","routeSlug":"/products/multi/openapi/authentication-factors/passwordupdate","metadata":{"seo":{"title":"Update a password","description":"Update the password for the logged-in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"passwordUpdate","name":"Update a password","isWebhook":false,"pointer":"/paths/~1passwords~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the password for the logged-in user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419","pointer":"/paths/~1passwords~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/passwords/update","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_419"}},"responseCodes":["200","400","401","403","404","409","410","429","500","503","default"],"pointer":"/passwords/update","href":"authentication-factors/passwordupdate","openApiOperationId":"passwordUpdate","summary":"Update a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1passwords~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/passwordupdate"}],"panels":[]}]},"httpPath":"/passwords/update"},{"label":"Validate a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/passwordvalidate","routeSlug":"/products/multi/openapi/authentication-factors/passwordvalidate","metadata":{"seo":{"title":"Validate a password","description":"Check that a password adheres to all complexity checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"passwordValidate","name":"Validate a password","isWebhook":false,"pointer":"/paths/~1passwords~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Check that a password adheres to all complexity checks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416","pointer":"/paths/~1passwords~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/passwords/validate","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_416"}},"responseCodes":["204","400","401","403","404","409","410","429","500","503","default"],"pointer":"/passwords/validate","href":"authentication-factors/passwordvalidate","openApiOperationId":"passwordValidate","summary":"Validate a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_416"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1passwords~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/passwordvalidate"}],"panels":[]}]},"httpPath":"/passwords/validate"},{"label":"Initiate lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/lostpasswordinitiate","routeSlug":"/products/multi/openapi/authentication-factors/lostpasswordinitiate","metadata":{"seo":{"title":"Initiate lost password process","description":"Initiate the lost password process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lostPasswordInitiate","name":"Initiate lost password process","isWebhook":false,"pointer":"/paths/~1passwords~1lost_password~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate lost password process","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":"Initiate the lost password process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the email address provided is associated with an active user, an email will be sent, containing a URL that redirects the user to change their password."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL contains request parameters for all of the parameters required to change the password for the user via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/passwords/lost_password/resume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" POST endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","pointer":"/paths/~1passwords~1lost_password~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/passwords/lost_password/start","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_393"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/passwords/lost_password/start","href":"authentication-factors/lostpasswordinitiate","openApiOperationId":"lostPasswordInitiate","summary":"Initiate lost password process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1passwords~1lost_password~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/lostpasswordinitiate"}],"panels":[]}]},"httpPath":"/passwords/lost_password/start"},{"label":"Resume lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/lostpasswordresume","routeSlug":"/products/multi/openapi/authentication-factors/lostpasswordresume","metadata":{"seo":{"title":"Resume lost password process","description":"This is the second and final step in updating the password of a user who forgot their password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lostPasswordResume","name":"Resume lost password process","isWebhook":false,"pointer":"/paths/~1passwords~1lost_password~1resume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume lost password process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is the second and final step in updating the password of a user who forgot their password."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423","pointer":"/paths/~1passwords~1lost_password~1resume/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/passwords/lost_password/resume","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_423"}},"responseCodes":["200","400","401","403","404","409","410","429","500","503","default"],"pointer":"/passwords/lost_password/resume","href":"authentication-factors/lostpasswordresume","openApiOperationId":"lostPasswordResume","summary":"Resume lost password process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_423"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}},"schemaId":"components/schemas/TokenResponse","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested token couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}},"schemaId":"schema_424"},{"code":"410","description":"Gone - The requested token is expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}},"schemaId":"components/schemas/TokenError","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1passwords~1lost_password~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenResponse"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"409","schemaId":"schema_424","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}}},{"code":"410","schemaId":"components/schemas/TokenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenError"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/lostpasswordresume"}],"panels":[]}]},"httpPath":"/passwords/lost_password/resume"},{"label":"Get user authentication factors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/authfactorsget","routeSlug":"/products/multi/openapi/authentication-factors/authfactorsget","metadata":{"seo":{"title":"Get user authentication factors","description":"Retrieves the list of authentication factors that can be used to verify the logged-in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authFactorsGet","name":"Get user authentication factors","isWebhook":false,"pointer":"/paths/~1authentication_factors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user authentication factors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of authentication factors that can be used to verify the logged-in user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authentication_factors","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/authentication_factors","href":"authentication-factors/authfactorsget","openApiOperationId":"authFactorsGet","summary":"Get user authentication factors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1authentication_factors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/authfactorsget"}],"panels":[]}]},"httpPath":"/authentication_factors"},{"label":"Enrol a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingotpstepone","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingotpstepone","metadata":{"seo":{"title":"Enrol a user device for authentication using one-time passwords","description":"This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrolDeviceUsingOtpStepOne","name":"Enrol a user device for authentication using one-time passwords","isWebhook":false,"pointer":"/paths/~1authentication_factors~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrol a user device for authentication using one-time passwords","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 is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"},{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentication_factors/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"},{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/authentication_factors/otp/{channel}","href":"authentication-factors/enroldeviceusingotpstepone","openApiOperationId":"enrolDeviceUsingOtpStepOne","summary":"Enrol a user device for authentication using one-time passwords"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/enroldeviceusingotpstepone"}],"panels":[]}]},"httpPath":"/authentication_factors/otp/{channel}"},{"label":"Verify enrolment of a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingotpsteptwo","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingotpsteptwo","metadata":{"seo":{"title":"Verify enrolment of a user device for authentication using one-time passwords","description":"The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions.The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrolDeviceUsingOtpStepTwo","name":"Verify enrolment of a user device for authentication using one-time passwords","isWebhook":false,"pointer":"/paths/~1authentication_factors~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify enrolment of a user device for authentication using one-time passwords","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 second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud, in that case challenge has to be issued again."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"},{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1authentication_factors~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentication_factors/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"},{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/authentication_factors/otp/{channel}/verify","href":"authentication-factors/enroldeviceusingotpsteptwo","openApiOperationId":"enrolDeviceUsingOtpStepTwo","summary":"Verify enrolment of a user device for authentication using one-time passwords"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1authentication_factors~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/enroldeviceusingotpsteptwo"}],"panels":[]}]},"httpPath":"/authentication_factors/otp/{channel}/verify"},{"label":"Enrol a user device for authentication using push notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/enroldeviceusingpush","routeSlug":"/products/multi/openapi/authentication-factors/enroldeviceusingpush","metadata":{"seo":{"title":"Enrol a user device for authentication using push notifications","description":"This is the first step in enrolling the logged-in user's mobile device, where a push notification is sent to the device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrolDeviceUsingPush","name":"Enrol a user device for authentication using push notifications","isWebhook":false,"pointer":"/paths/~1authentication_factors~1push~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrol a user device for authentication using push notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This is the first step in enrolling the logged-in user's mobile device, where a push notification is sent to the device.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"},{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_428","required":true}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authentication_factors/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/AuthSCAPushChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"},{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/authentication_factors/push/{channel}","href":"authentication-factors/enroldeviceusingpush","openApiOperationId":"enrolDeviceUsingPush","summary":"Enrol a user device for authentication using push notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/enroldeviceusingpush"}],"panels":[]}]},"httpPath":"/authentication_factors/push/{channel}"},{"label":"Unlink a user device for authentication using push notifications","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authentication-factors/unlinkdeviceusingpush","routeSlug":"/products/multi/openapi/authentication-factors/unlinkdeviceusingpush","metadata":{"seo":{"title":"Unlink a user device for authentication using push notifications","description":"Unlink a user device for authentication using push notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkDeviceUsingPush","name":"Unlink a user device for authentication using push notifications","isWebhook":false,"pointer":"/paths/~1authentication_factors~1push~1{channel}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink a user device for authentication using push notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unlink a user device for authentication using push notifications"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"},{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authentication_factors/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"},{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/authentication_factors/push/{channel}","href":"authentication-factors/unlinkdeviceusingpush","openApiOperationId":"unlinkDeviceUsingPush","summary":"Unlink a user device for authentication using push notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1authentication_factors~1push~1{channel}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/unlinkdeviceusingpush"}],"panels":[]}]},"httpPath":"/authentication_factors/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Authentication Factors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication Factors","showPageActions":true},{"nodeType":"markdoc","content":"Manage user authentication factors, including passwords and device-based factors (OTP and push)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/passwords/{user_id}/create","summary":"Create a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/passwordcreate","deprecated":false},{"title":"/passwords/update","summary":"Update a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/passwordupdate","deprecated":false},{"title":"/passwords/validate","summary":"Validate a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/passwordvalidate","deprecated":false},{"title":"/passwords/lost_password/start","summary":"Initiate lost password process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/lostpasswordinitiate","deprecated":false},{"title":"/passwords/lost_password/resume","summary":"Resume lost password process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/lostpasswordresume","deprecated":false},{"title":"/authentication_factors","summary":"Get user authentication factors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication-factors/authfactorsget","deprecated":false},{"title":"/authentication_factors/otp/{channel}","summary":"Enrol a user device for authentication using one-time passwords","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/enroldeviceusingotpstepone","deprecated":false},{"title":"/authentication_factors/otp/{channel}/verify","summary":"Verify enrolment of a user device for authentication using one-time passwords","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/enroldeviceusingotpsteptwo","deprecated":false},{"title":"/authentication_factors/push/{channel}","summary":"Enrol a user device for authentication using push notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/enroldeviceusingpush","deprecated":false},{"title":"/authentication_factors/push/{channel}","summary":"Unlink a user device for authentication using push notifications","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/authentication-factors/unlinkdeviceusingpush","deprecated":false}]}]}]}]}},{"type":"separator","label":"Access","content":null},{"type":"group","label":"Access Tokens","link":"/products/multi/openapi/access-tokens","routeSlug":"/products/multi/openapi/access-tokens","items":[{"label":"Acquire a new access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/access-tokens/requestaccesstoken","routeSlug":"/products/multi/openapi/access-tokens/requestaccesstoken","metadata":{"seo":{"title":"Acquire a new access token","description":"This API endpoint accepts a POST request with an auth_token parameter and returns an access_token that grants authorized access to additional resources within the API, with a different expiration time and unique signature."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestAccessToken","name":"Acquire a new access token","isWebhook":false,"pointer":"/paths/~1access_token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acquire a new access 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":"This API endpoint accepts a POST request with an auth_token parameter and returns an access_token that grants authorized access to additional resources within the API, with a different expiration time and unique signature."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]},{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432","pointer":"/paths/~1access_token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/access_token","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]},{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_432"}},"responseCodes":["200","400","401","403","423","429","500","503","default"],"pointer":"/access_token","href":"access-tokens/requestaccesstoken","openApiOperationId":"requestAccessToken","summary":"Acquire a new access token","securityGroups":[{"auth_token":[],"api-key":[]},{"api-key":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_432"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}},"schemaId":"schema_433","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"The auth token is not specified or is incorrect."},{"code":"423","description":"Locked - Account is temporarily locked due to failed consecutive login attempts. Try again in 30 minutes.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1access_token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_433","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403"},{"code":"423"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-tokens/requestaccesstoken"}],"panels":[]}]},"httpPath":"/access_token"}],"content":{"contentType":"group","meta":{"name":"Access Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Tokens","showPageActions":true},{"nodeType":"markdoc","content":"Acquire and revoke access tokens."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access_token","summary":"Acquire a new access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/access-tokens/requestaccesstoken","deprecated":false}]}]}]}]}},{"type":"separator","label":"Customer Settings","content":null},{"type":"group","label":"Customer Data & Due Diligence","link":"/products/multi/openapi/customer-data-and-due-diligence","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence","items":[{"label":"Get a corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporateget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporateget","metadata":{"seo":{"title":"Get a corporate","description":"Retrieve the details of the logged-in corporate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateGet","name":"Get a corporate","isWebhook":false,"pointer":"/paths/~1corporates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the logged-in corporate."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corporates","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/corporates","href":"customer-data-and-due-diligence/corporateget","openApiOperationId":"corporateGet","summary":"Get a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Corporate"}},"schemaId":"components/schemas/Corporate","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Corporate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Corporate"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/corporateget"}],"panels":[]}]},"httpPath":"/corporates"},{"label":"Update a corporate","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporateupdate","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporateupdate","metadata":{"seo":{"title":"Update a corporate","description":"Update the details of the logged-in corporate identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateUpdate","name":"Update a corporate","isWebhook":false,"pointer":"/paths/~1corporates/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a corporate","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 details of the logged-in corporate identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following Corporate details are verified during due diligence (KYB) and cannot be updated via the API once the Corporate has been verified:"},"children":[]}]}]},{"$$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":"Root User Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Root User Surname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Root User Email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Root User Mobile Country Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Root User Mobile Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth"},"children":[]}]}]}]},{"$$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":"If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1corporates/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434","pointer":"/paths/~1corporates/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/corporates","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_434"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/corporates","href":"customer-data-and-due-diligence/corporateupdate","openApiOperationId":"corporateUpdate","summary":"Update a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_434"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Corporate"}},"schemaId":"components/schemas/Corporate","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Corporate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Corporate"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/corporateupdate"}],"panels":[]}]},"httpPath":"/corporates"},{"label":"Start KYB for a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybstart","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybstart","metadata":{"seo":{"title":"Start KYB for a corporate","description":"Corporates need to complete due diligence (KYB) before they can create instruments and perform transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybStart","name":"Start KYB for a corporate","isWebhook":false,"pointer":"/paths/~1corporates~1kyb/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start KYB for a corporate","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":"Corporates need to complete due diligence (KYB) before they can create instruments and perform transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation initiates the due diligence process for the logged-in corporate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due Diligence is handled by a KYB provider - you will need to embed the KYB UI Component in your application so that the Corporate will be able to perform the KYB process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To initialise the KYB UI Component, you need a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is given you in the response of this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/kyb","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/corporates/kyb","href":"customer-data-and-due-diligence/corporatekybstart","openApiOperationId":"corporateKybStart","summary":"Start KYB for a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1kyb/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/corporatekybstart"}],"panels":[]}]},"httpPath":"/corporates/kyb"},{"label":"Get KYB for a corporate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/corporatekybget","metadata":{"seo":{"title":"Get KYB for a corporate","description":"Returns the KYB status for the logged-in corporate."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateKybGet","name":"Get KYB for a corporate","isWebhook":false,"pointer":"/paths/~1corporates~1kyb/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get KYB for a corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the KYB status for the logged-in corporate."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/corporates/kyb","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/corporates/kyb","href":"customer-data-and-due-diligence/corporatekybget","openApiOperationId":"corporateKybGet","summary":"Get KYB for a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1kyb/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/corporatekybget"}],"panels":[]}]},"httpPath":"/corporates/kyb"},{"label":"Get a consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerget","metadata":{"seo":{"title":"Get a consumer","description":"Retrieve the details of the logged-in Consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerGet","name":"Get a consumer","isWebhook":false,"pointer":"/paths/~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the logged-in Consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/consumers","href":"customer-data-and-due-diligence/consumerget","openApiOperationId":"consumerGet","summary":"Get a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}},"schemaId":"components/schemas/Consumer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Consumer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/consumerget"}],"panels":[]}]},"httpPath":"/consumers"},{"label":"Update a consumer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerupdate","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerupdate","metadata":{"seo":{"title":"Update a consumer","description":"Update the details of the logged-in consumer identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerUpdate","name":"Update a consumer","isWebhook":false,"pointer":"/paths/~1consumers/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a consumer","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 details of the logged-in consumer identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Consumer root user has already completed KYC, the following details cannot be 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":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile Country Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mobile Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date of Birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439","pointer":"/paths/~1consumers/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/consumers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_439"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/consumers","href":"customer-data-and-due-diligence/consumerupdate","openApiOperationId":"consumerUpdate","summary":"Update a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}},"schemaId":"components/schemas/Consumer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Consumer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Consumer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/consumerupdate"}],"panels":[]}]},"httpPath":"/consumers"},{"label":"Start KYC for a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycstart","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycstart","metadata":{"seo":{"title":"Start KYC for a consumer","description":"Consumers need to complete due diligence (KYC) before they can create instruments and fund transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerKycStart","name":"Start KYC for a consumer","isWebhook":false,"pointer":"/paths/~1consumers~1kyc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start KYC for a consumer","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":"Consumers need to complete due diligence (KYC) before they can create instruments and fund transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation initiates the due diligence process for the logged-in consumer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due Diligence is handled by a KYC provider, you will need to embed the KYC UI Component in your application to show the KYC screens to your users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To initialise the KYC UI Component, you need a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is given to you in the response of this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441","pointer":"/paths/~1consumers~1kyc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/consumers/kyc","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_441"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/consumers/kyc","href":"customer-data-and-due-diligence/consumerkycstart","openApiOperationId":"consumerKycStart","summary":"Start KYC for a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}},"schemaId":"schema_443"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers~1kyc/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_443","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/consumerkycstart"}],"panels":[]}]},"httpPath":"/consumers/kyc"},{"label":"Get KYC for a consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycget","routeSlug":"/products/multi/openapi/customer-data-and-due-diligence/consumerkycget","metadata":{"seo":{"title":"Get KYC for a consumer","description":"Returns the KYC status for the logged-in consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerKycGet","name":"Get KYC for a consumer","isWebhook":false,"pointer":"/paths/~1consumers~1kyc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get KYC for a consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the KYC status for the logged-in consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/consumers/kyc","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/consumers/kyc","href":"customer-data-and-due-diligence/consumerkycget","openApiOperationId":"consumerKycGet","summary":"Get KYC for a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers~1kyc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-data-and-due-diligence/consumerkycget"}],"panels":[]}]},"httpPath":"/consumers/kyc"}],"content":{"contentType":"group","meta":{"name":"Customer Data & Due Diligence"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer Data & Due Diligence","showPageActions":true},{"nodeType":"markdoc","content":"Manage customer profile data and KYC/KYB due diligence flows for corporates and consumers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/corporates","summary":"Get a corporate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-data-and-due-diligence/corporateget","deprecated":false},{"title":"/corporates","summary":"Update a corporate","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-data-and-due-diligence/corporateupdate","deprecated":false},{"title":"/corporates/kyb","summary":"Start KYB for a corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-data-and-due-diligence/corporatekybstart","deprecated":false},{"title":"/corporates/kyb","summary":"Get KYB for a corporate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-data-and-due-diligence/corporatekybget","deprecated":false},{"title":"/consumers","summary":"Get a consumer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-data-and-due-diligence/consumerget","deprecated":false},{"title":"/consumers","summary":"Update a consumer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-data-and-due-diligence/consumerupdate","deprecated":false},{"title":"/consumers/kyc","summary":"Start KYC for a consumer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-data-and-due-diligence/consumerkycstart","deprecated":false},{"title":"/consumers/kyc","summary":"Get KYC for a consumer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-data-and-due-diligence/consumerkycget","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorised Signatories","link":"/products/multi/openapi/authorised-signatories","routeSlug":"/products/multi/openapi/authorised-signatories","items":[{"label":"Send email verification code to Corporate root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverificationcodesend","routeSlug":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverificationcodesend","metadata":{"seo":{"title":"Send email verification code to Corporate root user","description":"The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateRootUserEmailVerificationCodeSend","name":"Send email verification code to Corporate root user","isWebhook":false,"pointer":"/paths/~1corporates~1verification~1email~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send email verification code to Corporate root user","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 first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code must then be provided in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corporateRootUserEmailVerify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to verify the root user's email address."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1corporates~1verification~1email~1send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","pointer":"/paths/~1corporates~1verification~1email~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/verification/email/send","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_393"}},"responseCodes":["204","400","401","404","409","429","500","503","default"],"pointer":"/corporates/verification/email/send","href":"authorised-signatories/corporaterootuseremailverificationcodesend","openApiOperationId":"corporateRootUserEmailVerificationCodeSend","summary":"Send email verification code to Corporate root user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1verification~1email~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-signatories/corporaterootuseremailverificationcodesend"}],"panels":[]}]},"httpPath":"/corporates/verification/email/send"},{"label":"Verify email of Corporate root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverify","routeSlug":"/products/multi/openapi/authorised-signatories/corporaterootuseremailverify","metadata":{"seo":{"title":"Verify email of Corporate root user","description":"The second step in verifying the root user's email. The randomly generated code sent to the root user viaemail, using the corporateRootUserEmailVerificationCodeSend operation, is submitted here to verify the root user's email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateRootUserEmailVerify","name":"Verify email of Corporate root user","isWebhook":false,"pointer":"/paths/~1corporates~1verification~1email~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify email of Corporate root user","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 second step in verifying the root user's email. The randomly generated code sent to the root user via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email, using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corporateRootUserEmailVerificationCodeSend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, is submitted here to verify the root user's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is needed as part of the verification process for basic due diligence."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/~1corporates~1verification~1email~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/verification/email/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/corporates/verification/email/verify","href":"authorised-signatories/corporaterootuseremailverify","openApiOperationId":"corporateRootUserEmailVerify","summary":"Verify email of Corporate root user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1verification~1email~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-signatories/corporaterootuseremailverify"}],"panels":[]}]},"httpPath":"/corporates/verification/email/verify"},{"label":"Send email verification code to Consumer root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverificationcodesend","routeSlug":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverificationcodesend","metadata":{"seo":{"title":"Send email verification code to Consumer root user","description":"The first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerRootUserEmailVerificationCodeSend","name":"Send email verification code to Consumer root user","isWebhook":false,"pointer":"/paths/~1consumers~1verification~1email~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send email verification code to Consumer root user","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 first step in verifying a root user's email. The root user whose email address is to be verified is sent an email containing a randomly generated code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This code must then be provided in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumerRootUserEmailVerify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to verify the root user's email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always set to \"123456\"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","pointer":"/paths/~1consumers~1verification~1email~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/consumers/verification/email/send","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_393"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/consumers/verification/email/send","href":"authorised-signatories/consumerrootuseremailverificationcodesend","openApiOperationId":"consumerRootUserEmailVerificationCodeSend","summary":"Send email verification code to Consumer root user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_393"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers~1verification~1email~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-signatories/consumerrootuseremailverificationcodesend"}],"panels":[]}]},"httpPath":"/consumers/verification/email/send"},{"label":"Verify email of Consumer root user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverify","routeSlug":"/products/multi/openapi/authorised-signatories/consumerrootuseremailverify","metadata":{"seo":{"title":"Verify email of Consumer root user","description":"The second step in verifying the root user's email. The randomly generated code sent to the root user viaemail, using the consumerRootUserEmailVerificationCodeSend operation, is submitted here to verify the root user's email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerRootUserEmailVerify","name":"Verify email of Consumer root user","isWebhook":false,"pointer":"/paths/~1consumers~1verification~1email~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify email of Consumer root user","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 second step in verifying the root user's email. The randomly generated code sent to the root user via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email, using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumerRootUserEmailVerificationCodeSend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, is submitted here to verify the root user's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is needed as part of the verification process for basic due diligence."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, emails are not sent and the verification code is always set to \"123456\"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/~1consumers~1verification~1email~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/consumers/verification/email/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/consumers/verification/email/verify","href":"authorised-signatories/consumerrootuseremailverify","openApiOperationId":"consumerRootUserEmailVerify","summary":"Verify email of Consumer root user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers~1verification~1email~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-signatories/consumerrootuseremailverify"}],"panels":[]}]},"httpPath":"/consumers/verification/email/verify"}],"content":{"contentType":"group","meta":{"name":"Authorised Signatories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorised Signatories","showPageActions":true},{"nodeType":"markdoc","content":"Verify the email of root users who act as authorised signatories of a Corporate or Consumer identity."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/corporates/verification/email/send","summary":"Send email verification code to Corporate root user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-signatories/corporaterootuseremailverificationcodesend","deprecated":false},{"title":"/corporates/verification/email/verify","summary":"Verify email of Corporate root user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-signatories/corporaterootuseremailverify","deprecated":false},{"title":"/consumers/verification/email/send","summary":"Send email verification code to Consumer root user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-signatories/consumerrootuseremailverificationcodesend","deprecated":false},{"title":"/consumers/verification/email/verify","summary":"Verify email of Consumer root user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-signatories/consumerrootuseremailverify","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorised Users","link":"/products/multi/openapi/authorised-users","routeSlug":"/products/multi/openapi/authorised-users","items":[{"label":"Link an existing user to your identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userlink","routeSlug":"/products/multi/openapi/authorised-users/userlink","metadata":{"seo":{"title":"Link an existing user to your identity","description":"Links a user that already exists on another identity to your identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userLink","name":"Link an existing user to your identity","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1link/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link an existing user to your identity","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":"Links a user that already exists on another identity to your identity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since the user's credentials are already set up, no invitation or password setup is required - once linked, the user gains access to the identity immediately and can select it on login."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to link a user you would need a stepped-up token. Before calling this operation you need to step-up ( issue a challenge "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multi/stepup/challenges/otp/{channel}"},"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":"More details on how to step-up a token can be found here "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Step-up-Challenges/operation/stepupSCAChallenge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-Up"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1link/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1users~1{user_id}~1link/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/link","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/users/{user_id}/link","href":"authorised-users/userlink","openApiOperationId":"userLink","summary":"Link an existing user to your identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-users/userlink"}],"panels":[]}]},"httpPath":"/users/{user_id}/link"},{"label":"Deactivate an authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userdeactivate","routeSlug":"/products/multi/openapi/authorised-users/userdeactivate","metadata":{"seo":{"title":"Deactivate an authorised user","description":"De-activate the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userDeactivate","name":"Deactivate an authorised user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an authorised user","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":"De-activate the user identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivated users cannot log in or execute any operations with their credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivation is identity-specific and if the user belongs to multiple identities, deactivation applies only to the identity that the caller of this operation is representing. Deactivating a user on one identity does not affect other identities."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/deactivate","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500","503","default"],"pointer":"/users/{user_id}/deactivate","href":"authorised-users/userdeactivate","openApiOperationId":"userDeactivate","summary":"Deactivate an authorised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-users/userdeactivate"}],"panels":[]}]},"httpPath":"/users/{user_id}/deactivate"},{"label":"Reactivate an authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/useractivate","routeSlug":"/products/multi/openapi/authorised-users/useractivate","metadata":{"seo":{"title":"Reactivate an authorised user","description":"Re-activate the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userActivate","name":"Reactivate an authorised user","isWebhook":false,"pointer":"/paths/~1users~1{user_id}~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reactivate an authorised user","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":"Re-activate the user identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, any new users created will be automatically activated. This operation needs to be used only if the user was previously de-activated using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userDeactivate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, or if the user was de-activated automatically after multiple incorrect login attempts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user belongs to multiple identities, activation is identity-specific and applies only to the identity that the caller of this operation is representing. Activating a user on one identity does not affect other identities."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_382","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1users~1{user_id}~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/{user_id}/activate","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500","503","default"],"pointer":"/users/{user_id}/activate","href":"authorised-users/useractivate","openApiOperationId":"userActivate","summary":"Reactivate an authorised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1{user_id}~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-users/useractivate"}],"panels":[]}]},"httpPath":"/users/{user_id}/activate"},{"label":"Start KYC to elevate an authorised user to signatory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/authorised-users/userkyc","routeSlug":"/products/multi/openapi/authorised-users/userkyc","metadata":{"seo":{"title":"Start KYC to elevate an authorised user to signatory","description":"Perform the kyc for a corporate user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userKyc","name":"Start KYC to elevate an authorised user to signatory","isWebhook":false,"pointer":"/paths/~1users~1kyc/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start KYC to elevate an authorised user to signatory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform the kyc for a corporate user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users/kyc","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500","503","default"],"pointer":"/users/kyc","href":"authorised-users/userkyc","openApiOperationId":"userKyc","summary":"Start KYC to elevate an authorised user to signatory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1users~1kyc/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-users/userkyc"}],"panels":[]}]},"httpPath":"/users/kyc"}],"content":{"contentType":"group","meta":{"name":"Authorised Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorised Users","showPageActions":true},{"nodeType":"markdoc","content":"Manage the lifecycle of authorised users that can access your identity, including linking existing users, activation and de-activation, and KYC verification."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users/{user_id}/link","summary":"Link an existing user to your identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-users/userlink","deprecated":false},{"title":"/users/{user_id}/deactivate","summary":"Deactivate an authorised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-users/userdeactivate","deprecated":false},{"title":"/users/{user_id}/activate","summary":"Reactivate an authorised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-users/useractivate","deprecated":false},{"title":"/users/kyc","summary":"Start KYC to elevate an authorised user to signatory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-users/userkyc","deprecated":false}]}]}]}]}},{"type":"group","label":"Trusted Payees","link":"/products/multi/openapi/trusted-payees","routeSlug":"/products/multi/openapi/trusted-payees","items":[{"label":"Add payees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchcreate","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchcreate","metadata":{"seo":{"title":"Add payees","description":"Payees (previously \"beneficiaries\"). Create one or more payees for the logged-in corporate or consumer identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchCreate","name":"Add payees","isWebhook":false,"pointer":"/paths/~1beneficiaries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add payees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Create one or more payees for the logged-in corporate or consumer identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1beneficiaries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449","pointer":"/paths/~1beneficiaries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiaries","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_449"}},"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/beneficiaries","href":"trusted-payees/beneficiarybatchcreate","openApiOperationId":"beneficiaryBatchCreate","summary":"Add payees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_449"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}},"schemaId":"components/schemas/BeneficiaryBatch","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BeneficiaryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchcreate"}],"panels":[]}]},"httpPath":"/beneficiaries"},{"label":"Get all payees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiariesget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiariesget","metadata":{"seo":{"title":"Get all payees","description":"Payees (previously \"beneficiaries\"). Retrieves the payees that match the query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiariesGet","name":"Get all payees","isWebhook":false,"pointer":"/paths/~1beneficiaries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all payees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Retrieves the payees that match the query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"batchId","in":"query","schemaId":"schema_450","description":"Search by the payee batch id."},{"name":"group","in":"query","schemaId":"schema_451","description":"Search by the payee group."}],"pointer":"/paths/~1beneficiaries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beneficiaries","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"batchId","in":"query","required":false,"schemaId":"schema_450"},{"name":"group","in":"query","required":false,"schemaId":"schema_451"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/beneficiaries","href":"trusted-payees/beneficiariesget","openApiOperationId":"beneficiariesGet","summary":"Get all payees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiariesget"}],"panels":[]}]},"httpPath":"/beneficiaries"},{"label":"Remove payees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchremove","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchremove","metadata":{"seo":{"title":"Remove payees","description":"Payees (previously \"beneficiaries\"). Removes one or more payees from the payees list identified by the id path parameter used in the array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchRemove","name":"Remove payees","isWebhook":false,"pointer":"/paths/~1beneficiaries~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove payees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Removes one or more payees from the payees list identified by the id path parameter used in the array."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1beneficiaries~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453","pointer":"/paths/~1beneficiaries~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiaries/remove","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_453"}},"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/beneficiaries/remove","href":"trusted-payees/beneficiarybatchremove","openApiOperationId":"beneficiaryBatchRemove","summary":"Remove payees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_453"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}},"schemaId":"components/schemas/BeneficiaryBatch","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BeneficiaryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchremove"}],"panels":[]}]},"httpPath":"/beneficiaries/remove"},{"label":"Get a payee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiaryget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiaryget","metadata":{"seo":{"title":"Get a payee","description":"Payees (previously \"beneficiaries\"). Retrieves a payee identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryGet","name":"Get a payee","isWebhook":false,"pointer":"/paths/~1beneficiaries~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a payee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Retrieves a payee identified by the id path parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a payee.","required":true}],"pointer":"/paths/~1beneficiaries~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beneficiaries/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/beneficiaries/{id}","href":"trusted-payees/beneficiaryget","openApiOperationId":"beneficiaryGet","summary":"Get a payee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Beneficiary"}},"schemaId":"components/schemas/Beneficiary","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Beneficiary","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Beneficiary"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiaryget"}],"panels":[]}]},"httpPath":"/beneficiaries/{id}"},{"label":"Get all payee batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchesget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchesget","metadata":{"seo":{"title":"Get all payee batches","description":"Payees (previously \"beneficiaries\"). Retrieves all payee batches matching the query parameters and that belong to the logged-in identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchesGet","name":"Get all payee batches","isWebhook":false,"pointer":"/paths/~1beneficiaries~1batch/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all payee batches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Retrieves all payee batches matching the query parameters and that belong to the logged-in identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"state","in":"query","schemaId":"schema_454"},{"name":"operation","in":"query","schemaId":"schema_455"},{"name":"tag","in":"query","schemaId":"schema_451","description":"Filter by the payee batch tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries."}],"pointer":"/paths/~1beneficiaries~1batch/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beneficiaries/batch","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"state","in":"query","required":false,"schemaId":"schema_454"},{"name":"operation","in":"query","required":false,"schemaId":"schema_455"},{"name":"tag","in":"query","required":false,"schemaId":"schema_451"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/beneficiaries/batch","href":"trusted-payees/beneficiarybatchesget","openApiOperationId":"beneficiaryBatchesGet","summary":"Get all payee batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}},"schemaId":"schema_456","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1batch/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_456","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchesget"}],"panels":[]}]},"httpPath":"/beneficiaries/batch"},{"label":"Get a batch of payees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchget","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchget","metadata":{"seo":{"title":"Get a batch of payees","description":"Payees (previously \"beneficiaries\"). Retrieves the details of a payee batch identified by the batchId path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchGet","name":"Get a batch of payees","isWebhook":false,"pointer":"/paths/~1beneficiaries~1batch~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a batch of payees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Payees (previously \"beneficiaries\"). Retrieves the details of a payee batch identified by the batchId path parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a payee batch.","required":true}],"pointer":"/paths/~1beneficiaries~1batch~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beneficiaries/batch/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/beneficiaries/batch/{id}","href":"trusted-payees/beneficiarybatchget","openApiOperationId":"beneficiaryBatchGet","summary":"Get a batch of payees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}},"schemaId":"components/schemas/BeneficiaryBatch","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1batch~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BeneficiaryBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatch"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchget"}],"panels":[]}]},"httpPath":"/beneficiaries/batch/{id}"},{"label":"Issue OTP to verify batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallenge","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallenge","metadata":{"seo":{"title":"Issue OTP to verify batch","description":"Payees (previously \"beneficiaries\"). Starts the verification process for updating the payees batch in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchSCAChallenge","name":"Issue OTP to verify batch","isWebhook":false,"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue OTP to verify batch","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":"Payees (previously \"beneficiaries\"). Starts the verification process for updating the payees batch in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/otp/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the payee update "},"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":"PENDING_CHALLENGE"},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Payee Batch Operation.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiaries/batch/{id}/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/beneficiaries/batch/{id}/challenges/otp/{channel}","href":"trusted-payees/beneficiarybatchscachallenge","openApiOperationId":"beneficiaryBatchSCAChallenge","summary":"Issue OTP to verify batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchscachallenge"}],"panels":[]}]},"httpPath":"/beneficiaries/batch/{id}/challenges/otp/{channel}"},{"label":"Verify batch using OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscaverify","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscaverify","metadata":{"seo":{"title":"Verify batch using OTP","description":"Payees (previously \"beneficiaries\"). Completes the verification process for updating the payee batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchSCAVerify","name":"Verify batch using OTP","isWebhook":false,"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify batch using OTP","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":"Payees (previously \"beneficiaries\"). Completes the verification process for updating the payee batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the outcome of the verification is successful, the payee update batch is executed."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the verificationCode is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Payee Batch Operation.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiaries/batch/{id}/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/beneficiaries/batch/{id}/challenges/otp/{channel}/verify","href":"trusted-payees/beneficiarybatchscaverify","openApiOperationId":"beneficiaryBatchSCAVerify","summary":"Verify batch using OTP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}},"schemaId":"schema_458"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_458","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchscaverify"}],"panels":[]}]},"httpPath":"/beneficiaries/batch/{id}/challenges/otp/{channel}/verify"},{"label":"Issue push to verify batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallengepush","routeSlug":"/products/multi/openapi/trusted-payees/beneficiarybatchscachallengepush","metadata":{"seo":{"title":"Issue push to verify batch","description":"Payees (previously \"beneficiaries\"). Starts the verification process for updating a payee batch in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiaryBatchSCAChallengePush","name":"Issue push to verify batch","isWebhook":false,"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1push~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue push to verify batch","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":"Payees (previously \"beneficiaries\"). Starts the verification process for updating a payee batch in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/push/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the payee update operation "},"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":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Payee Batch Operation.","required":true},{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1push~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiaries/batch/{id}/challenges/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/beneficiaries/batch/{id}/challenges/push/{channel}","href":"trusted-payees/beneficiarybatchscachallengepush","openApiOperationId":"beneficiaryBatchSCAChallengePush","summary":"Issue push to verify batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1beneficiaries~1batch~1{id}~1challenges~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiarybatchscachallengepush"}],"panels":[]}]},"httpPath":"/beneficiaries/batch/{id}/challenges/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Trusted Payees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trusted Payees","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 a list of trusted payees for Outgoing wire transfers and Sends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aside from convenience and a reduced chance of making errors when making transactions,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this allows for the introduction an SCA exemption, where the account holder can request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that transactions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRUSTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payees to be exempted from the requirement to pass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an SCA challenge every time."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beneficiaries","summary":"Add payees","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiarybatchcreate","deprecated":false},{"title":"/beneficiaries","summary":"Get all payees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trusted-payees/beneficiariesget","deprecated":false},{"title":"/beneficiaries/remove","summary":"Remove payees","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiarybatchremove","deprecated":false},{"title":"/beneficiaries/{id}","summary":"Get a payee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trusted-payees/beneficiaryget","deprecated":false},{"title":"/beneficiaries/batch","summary":"Get all payee batches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trusted-payees/beneficiarybatchesget","deprecated":false},{"title":"/beneficiaries/batch/{id}","summary":"Get a batch of payees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trusted-payees/beneficiarybatchget","deprecated":false},{"title":"/beneficiaries/batch/{id}/challenges/otp/{channel}","summary":"Issue OTP to verify batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiarybatchscachallenge","deprecated":false},{"title":"/beneficiaries/batch/{id}/challenges/otp/{channel}/verify","summary":"Verify batch using OTP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiarybatchscaverify","deprecated":false},{"title":"/beneficiaries/batch/{id}/challenges/push/{channel}","summary":"Issue push to verify batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiarybatchscachallengepush","deprecated":false}]}]}]}]}},{"type":"separator","label":"Instruments","content":null},{"type":"group","label":"Managed Accounts","link":"/products/multi/openapi/managed-accounts","routeSlug":"/products/multi/openapi/managed-accounts","items":[{"label":"Get all managed accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountsget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountsget","metadata":{"seo":{"title":"Get all managed accounts","description":"Retrieves all managed accounts belonging to the logged-in identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountsGet","name":"Get all managed accounts","isWebhook":false,"pointer":"/paths/~1managed_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all managed accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all managed accounts belonging to the logged-in identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the managed account/card profile. Leave out to fetch all managed accounts/card."},{"name":"friendlyName","in":"query","schemaId":"schema_460","description":"Filter by the managed account/card friendly name. Leave out to fetch all managed accounts/card.\n\nThe exact name must be provided, as wildcards are not supported.\n"},{"name":"state","in":"query","schemaId":"schema_461"},{"name":"state.blockedReason","in":"query","schemaId":"schema_462"},{"name":"state.destroyedReason","in":"query","schemaId":"schema_463"},{"name":"currency","in":"query","schemaId":"schema_464","description":"Filter by the managed account/card currency.\n\nCurrencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.\n"},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for managed accounts/cards created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for managed accounts/cards created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards."},"children":[]}]}]}]},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card."}],"pointer":"/paths/~1managed_accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"friendlyName","in":"query","required":false,"schemaId":"schema_460"},{"name":"state","in":"query","required":false,"schemaId":"schema_461"},{"name":"state.blockedReason","in":"query","required":false,"schemaId":"schema_462"},{"name":"state.destroyedReason","in":"query","required":false,"schemaId":"schema_463"},{"name":"currency","in":"query","required":false,"schemaId":"components/schemas/Currency"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/managed_accounts","href":"managed-accounts/managedaccountsget","openApiOperationId":"managedAccountsGet","summary":"Get all managed accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}},"schemaId":"schema_466","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_466","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountsget"}],"panels":[]}]},"httpPath":"/managed_accounts"},{"label":"Create a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountcreate","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountcreate","metadata":{"seo":{"title":"Create a managed account","description":"Creates a managed account for the consumer or corporate identity. The Managed Account Profile (configured in the Multi Portal) specified determines the behavior and restrictions that the managed account will have.\""}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountCreate","name":"Create a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a managed account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a managed account for the consumer or corporate identity.\nThe Managed Account Profile (configured in the Multi Portal) specified determines the behavior and restrictions that the managed account will have.\"\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_467"}},"schemaId":"schema_467","pointer":"/paths/~1managed_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_accounts","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_467"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/managed_accounts","href":"managed-accounts/managedaccountcreate","openApiOperationId":"managedAccountCreate","summary":"Create a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_467","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_467"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}},"schemaId":"components/schemas/ManagedAccount","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}},"schemaId":"schema_468"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"409","schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountcreate"}],"panels":[]}]},"httpPath":"/managed_accounts"},{"label":"Get a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountget","metadata":{"seo":{"title":"Get a managed account","description":"Fetch the managed account identified by the id in path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountGet","name":"Get a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed 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":"Fetch the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in path."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Managed Account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}","href":"managed-accounts/managedaccountget","openApiOperationId":"managedAccountGet","summary":"Get a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}},"schemaId":"components/schemas/ManagedAccount","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountget"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}"},{"label":"Update a managed account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountupdate","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountupdate","metadata":{"seo":{"title":"Update a managed account","description":"Update the details for the managed account identified by the id in the path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountUpdate","name":"Update a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a managed 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":"Update the details for the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the path."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1managed_accounts~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/managed_accounts/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}","href":"managed-accounts/managedaccountupdate","openApiOperationId":"managedAccountUpdate","summary":"Update a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}},"schemaId":"components/schemas/ManagedAccount","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccount"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountupdate"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}"},{"label":"Upgrade a managed account with IBAN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountsibanupgrade","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountsibanupgrade","metadata":{"seo":{"title":"Upgrade a managed account with IBAN","description":"Assign an IBAN to a Managed Account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountsIBANUpgrade","name":"Upgrade a managed account with IBAN","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1iban/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upgrade a managed account with IBAN","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":"Assign an IBAN to a Managed Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IBANs enable managed accounts to receive and send funds via wire transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigning an IBAN to a Managed Account may be done asynchronously, in which case the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ManagedAccountIBAN.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_ALLOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until bank details are ready to use."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Managed Account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1iban/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_accounts~1{id}~1iban/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_accounts/{id}/iban","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_accounts/{id}/iban","href":"managed-accounts/managedaccountsibanupgrade","openApiOperationId":"managedAccountsIBANUpgrade","summary":"Upgrade a managed account with IBAN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccountIBAN"}},"schemaId":"components/schemas/ManagedAccountIBAN","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1iban/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedAccountIBAN","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccountIBAN"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountsibanupgrade"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/iban"},{"label":"Get a managed account IBAN","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountibanget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountibanget","metadata":{"seo":{"title":"Get a managed account IBAN","description":"Fetch the IBAN details associated with the Managed Account identified by the id in the path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountIBANGet","name":"Get a managed account IBAN","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1iban/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed account IBAN","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 the IBAN details associated with the Managed Account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the path."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1iban/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts/{id}/iban","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}/iban","href":"managed-accounts/managedaccountibanget","openApiOperationId":"managedAccountIBANGet","summary":"Get a managed account IBAN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccountIBAN"}},"schemaId":"components/schemas/ManagedAccountIBAN","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1iban/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedAccountIBAN","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedAccountIBAN"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountibanget"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/iban"},{"label":"Block a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountblock","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountblock","metadata":{"seo":{"title":"Block a managed account","description":"Temporarily blocks a managed account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountBlock","name":"Block a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1block/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block a managed account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Temporarily blocks a managed account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1block/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_accounts~1{id}~1block/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_accounts/{id}/block","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_accounts/{id}/block","href":"managed-accounts/managedaccountblock","openApiOperationId":"managedAccountBlock","summary":"Block a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}},"schemaId":"schema_471"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_471","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountblock"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/block"},{"label":"Unblock a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountunblock","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountunblock","metadata":{"seo":{"title":"Unblock a managed account","description":"Unblocks the managed account identified by the id path parameter.The managed account must have state.blockedReason as USER so that it can be unblocked.If the managed account was blocked by SYSTEM, users cannot unblock it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountUnblock","name":"Unblock a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1unblock/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock a managed 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":"Unblocks the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The managed account must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state.blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so that it can be unblocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the managed account was blocked by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SYSTEM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users cannot unblock it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1unblock/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_accounts~1{id}~1unblock/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_accounts/{id}/unblock","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_accounts/{id}/unblock","href":"managed-accounts/managedaccountunblock","openApiOperationId":"managedAccountUnblock","summary":"Unblock a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}},"schemaId":"schema_472"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1unblock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountunblock"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/unblock"},{"label":"Get a managed account statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountstatement","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountstatement","metadata":{"seo":{"title":"Get a managed account statement","description":"Returns a statement for the managed account identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountStatement","name":"Get a managed account statement","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1statement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed account 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":"Returns a statement for the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement contains only posted/completed transactions where funds have definitively moved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the actual balance of the instrument changed). In progress transactions are not included but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be retrieved via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.weavr.io/products/multi/openapi/managed-accounts/managedaccounttransactionsget#tag/Managed-Accounts/operation/managedAccountTransactionsGet"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction activity 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":"Repeated requests for the same statement period will return the same result."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_473","description":"The maximum number of statement entries to return. Limit is capped at 500."},{"name":"startPeriod","in":"query","schemaId":"schema_465","description":"Start of the statement period. Epoch timestamp using millisecond precision."},{"name":"endPeriod","in":"query","schemaId":"schema_465","description":"End of the statement period. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"schema_474","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first (default for statements)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]},{"name":"transaction.type","in":"query","schemaId":"schema_475","description":"Filter statement entries by one or more transaction types."},{"name":"executingAccessInstrument.id","in":"query","schemaId":"components/schemas/Id","description":"Filter statement entries by the ID of the access instrument that initiated the transaction."},{"name":"executingAccessInstrument.type","in":"query","schemaId":"schema_476","description":"Filter statement entries by the type of access instrument that initiated the transaction (managed cards or IBANs)."}],"pointer":"/paths/~1managed_accounts~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]},{"name":"x-api-version","in":"header","schemaId":"schema_477","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts the call in to the latest version of the endpoint. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LATEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be routed to the newest implementation; omit to retain the default routing for your tenant."},"children":[]}]}]}]}],"pointer":"/paths/~1managed_accounts~1{id}~1statement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts/{id}/statement","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_473"},{"name":"startPeriod","in":"query","required":false,"schemaId":"schema_465"},{"name":"endPeriod","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"transaction.type","in":"query","required":false,"schemaId":"schema_475"},{"name":"executingAccessInstrument.id","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"executingAccessInstrument.type","in":"query","required":false,"schemaId":"schema_476"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"},{"name":"x-api-version","in":"header","required":false,"schemaId":"schema_477"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}/statement","href":"managed-accounts/managedaccountstatement","openApiOperationId":"managedAccountStatement","summary":"Get a managed account statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"},"application/pdf":{"schemaId":"schema_478"}},"schemaId":"components/schemas/StatementResponse","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1statement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"},"application/pdf":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountstatement"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/statement"},{"label":"Get transaction activity for a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccounttransactionsget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccounttransactionsget","metadata":{"seo":{"title":"Get transaction activity for a managed account","description":"Returns all transactional activity on the managed account identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountTransactionsGet","name":"Get transaction activity for a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction activity for a managed 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":"Returns all transactional activity on the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the statement endpoint, this includes pending, completed, failed, and rejected transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All transaction types are returned in a unified schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"type","in":"query","schemaId":"schema_479","description":"Filter by one or more transaction activity types."},{"name":"status","in":"query","schemaId":"schema_480","description":"Filter by one or more normalised transaction statuses."},{"name":"direction","in":"query","schemaId":"schema_481","description":"Filter by transaction direction (CREDIT or DEBIT)."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision."},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated after this timestamp. Useful for pulling recently changed transactions. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated before this timestamp. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_482","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort transaction activity results by. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1managed_accounts~1{id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts/{id}/transactions","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"type","in":"query","required":false,"schemaId":"schema_479"},{"name":"status","in":"query","required":false,"schemaId":"schema_480"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/TransactionActivityDirection"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/TransactionActivitySortBy"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}/transactions","href":"managed-accounts/managedaccounttransactionsget","openApiOperationId":"managedAccountTransactionsGet","summary":"Get transaction activity for a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityList"}},"schemaId":"components/schemas/InstrumentTransactionActivityList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentTransactionActivityList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccounttransactionsget"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/transactions"},{"label":"Get a specific transaction for a managed account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccounttransactionget","routeSlug":"/products/multi/openapi/managed-accounts/managedaccounttransactionget","metadata":{"seo":{"title":"Get a specific transaction for a managed account","description":"Returns a specific transaction on the managed account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountTransactionGet","name":"Get a specific transaction for a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific transaction for a managed account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific transaction on the managed account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true},{"name":"transactionId","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the transaction.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_accounts/{id}/transactions/{transactionId}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_accounts/{id}/transactions/{transactionId}","href":"managed-accounts/managedaccounttransactionget","openApiOperationId":"managedAccountTransactionGet","summary":"Get a specific transaction for a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityItem"}},"schemaId":"components/schemas/InstrumentTransactionActivityItem","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentTransactionActivityItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityItem"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccounttransactionget"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/transactions/{transactionId}"},{"label":"Remove a managed account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountremove","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountremove","metadata":{"seo":{"title":"Remove a managed account","description":"Destroys the managed account identified by the id path parameter. Unlike block, this action is not reversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountRemove","name":"Remove a managed account","isWebhook":false,"pointer":"/paths/~1managed_accounts~1{id}~1remove/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a managed 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":"Destroys the managed account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. Unlike block, this action is not reversible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A managed account must be emptied from any remaining funds before it can be destroyed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1managed_accounts~1{id}~1remove/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_accounts/{id}/remove","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_accounts/{id}/remove","href":"managed-accounts/managedaccountremove","openApiOperationId":"managedAccountRemove","summary":"Remove a managed account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}},"schemaId":"schema_483"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_accounts~1{id}~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_483","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountremove"}],"panels":[]}]},"httpPath":"/managed_accounts/{id}/remove"},{"label":"Get a managed account statement (legacy)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-accounts/managedaccountstatementdeprecated","routeSlug":"/products/multi/openapi/managed-accounts/managedaccountstatementdeprecated","metadata":{"seo":{"title":"Get a managed account statement (legacy)","description":"Deprecated in favour of GET /managed_accounts/{id}/statements, which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our changelog."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedAccountStatementDeprecated","name":"Get a managed account statement (legacy)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1deprecated~1managed_accounts~1{id}~1statement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed account statement (legacy)","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.weavr.io/products/multi/openapi/managed-accounts/managedaccountstatement#tag/Managed-Accounts/operation/managedAccountStatements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /managed_accounts/{id}/statements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.weavr.io/changelog/2026/06/23/multi/release-113/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changelog"},"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 endpoint returns a list of transactions (in our legacy format) for a managed account, identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter, matching the criteria provided in the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed account.","required":true}],"pointer":"/paths/~1deprecated~1managed_accounts~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"statementLimit","in":"query","schemaId":"schema_473","description":"The limit of the results for statements paging, starting at the offset. Limit is capped at 500."},{"name":"orderByTimestamp","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders the result in ascending or descending 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":"ASC: Ascending order, oldest transactions first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent transactions first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, the transactions will be returned in descending order."},"children":[]}]}]}]},{"name":"fromTimestamp","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transactions having transaction timestamp after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included."},"children":[]}]}]}]},{"name":"toTimestamp","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transactions having transaction timestamp before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included. If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"showFundMovementsOnly","in":"query","schemaId":"schema_378","description":"Deprecated. Use singleEntryPerTransaction instead.\n\nReturns only the entries which contain fund movements.\n"},{"name":"singleEntryPerTransaction","in":"query","schemaId":"schema_378","description":"Returns transactions that span multiple movements as a single entry.\nOnly includes transactions that have been completed.\nDefaults to true for PDF statements, false otherwise.\nNote: due to the fact that only completed transactions are included, some\ntransactions that are in progress and have modified the balance of the instrument\nwill not be shown, which could lead to seemingly inconsistent balance being displayed.\n"},{"name":"transactionType","in":"query","schemaId":"schema_484","description":"Filter by the transaction type. Leave out to fetch all entries."}],"pointer":"/paths/~1deprecated~1managed_accounts~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]}],"pointer":"/paths/~1deprecated~1managed_accounts~1{id}~1statement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deprecated/managed_accounts/{id}/statement","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"statementLimit","in":"query","required":false,"schemaId":"schema_473"},{"name":"orderByTimestamp","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"fromTimestamp","in":"query","required":false,"schemaId":"schema_465"},{"name":"toTimestamp","in":"query","required":false,"schemaId":"schema_465"},{"name":"showFundMovementsOnly","in":"query","required":false,"schemaId":"schema_378"},{"name":"singleEntryPerTransaction","in":"query","required":false,"schemaId":"schema_378"},{"name":"transactionType","in":"query","required":false,"schemaId":"schema_484"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/deprecated/managed_accounts/{id}/statement","href":"managed-accounts/managedaccountstatementdeprecated","openApiOperationId":"managedAccountStatementDeprecated","summary":"Get a managed account statement (legacy)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/pdf","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"},"application/pdf":{"schemaId":"schema_478"},"text/csv":{"schemaId":"schema_485"}},"schemaId":"components/schemas/Statement","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1deprecated~1managed_accounts~1{id}~1statement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json","application/pdf","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"},"application/pdf":{"schemaId":"schema_478"},"text/csv":{"schemaId":"schema_485"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managedaccountstatementdeprecated"}],"panels":[]}]},"httpPath":"/deprecated/managed_accounts/{id}/statement"}],"content":{"contentType":"group","meta":{"name":"Managed Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managed 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":"Managed Accounts are a type of financial instrument offered by Weavr."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managed accounts can also be used as source and destination instruments in the "},"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":"send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/managed_accounts","summary":"Get all managed accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccountsget","deprecated":false},{"title":"/managed_accounts","summary":"Create a managed account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managedaccountcreate","deprecated":false},{"title":"/managed_accounts/{id}","summary":"Get a managed account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccountget","deprecated":false},{"title":"/managed_accounts/{id}","summary":"Update a managed account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/managed-accounts/managedaccountupdate","deprecated":false},{"title":"/managed_accounts/{id}/iban","summary":"Upgrade a managed account with IBAN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managedaccountsibanupgrade","deprecated":false},{"title":"/managed_accounts/{id}/iban","summary":"Get a managed account IBAN","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccountibanget","deprecated":false},{"title":"/managed_accounts/{id}/block","summary":"Block a managed account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managedaccountblock","deprecated":false},{"title":"/managed_accounts/{id}/unblock","summary":"Unblock a managed account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managedaccountunblock","deprecated":false},{"title":"/managed_accounts/{id}/statement","summary":"Get a managed account statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccountstatement","deprecated":false},{"title":"/managed_accounts/{id}/transactions","summary":"Get transaction activity for a managed account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccounttransactionsget","deprecated":false},{"title":"/managed_accounts/{id}/transactions/{transactionId}","summary":"Get a specific transaction for a managed account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-accounts/managedaccounttransactionget","deprecated":false},{"title":"/managed_accounts/{id}/remove","summary":"Remove a managed account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managedaccountremove","deprecated":false},{"title":"/deprecated/managed_accounts/{id}/statement","summary":"Get a managed account statement (legacy)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/managed-accounts/managedaccountstatementdeprecated","deprecated":true}]}]}]}]}},{"type":"group","label":"Managed Cards","link":"/products/multi/openapi/managed-cards","routeSlug":"/products/multi/openapi/managed-cards","items":[{"label":"Create a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardcreate","routeSlug":"/products/multi/openapi/managed-cards/managedcardcreate","metadata":{"seo":{"title":"Create a managed card","description":"Creates a managed card for the consumer or corporate identity. The Managed Card Profile (configured in the Multi Portal) specified determines the behaviour and restrictions that the managed card will have."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardCreate","name":"Create a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a managed card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a managed card for the consumer or corporate identity.\nThe Managed Card Profile (configured in the Multi Portal) specified determines the behaviour and restrictions that the managed card will have.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardRequest"}},"schemaId":"components/schemas/ManagedCardRequest","pointer":"/paths/~1managed_cards/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardRequest"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/managed_cards","href":"managed-cards/managedcardcreate","openApiOperationId":"managedCardCreate","summary":"Create a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}},"schemaId":"schema_486"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"409","schemaId":"schema_486","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardcreate"}],"panels":[]}]},"httpPath":"/managed_cards"},{"label":"Get all managed cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardsget","routeSlug":"/products/multi/openapi/managed-cards/managedcardsget","metadata":{"seo":{"title":"Get all managed cards","description":"Fetch cards matching the search criteria provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardsGet","name":"Get all managed cards","isWebhook":false,"pointer":"/paths/~1managed_cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all managed cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch cards matching the search criteria provided."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the managed account/card profile. Leave out to fetch all managed accounts/card."},{"name":"friendlyName","in":"query","schemaId":"schema_460","description":"Filter by the managed account/card friendly name. Leave out to fetch all managed accounts/card.\n\nThe exact name must be provided, as wildcards are not supported.\n"},{"name":"state","in":"query","schemaId":"schema_461"},{"name":"state.blockedReason","in":"query","schemaId":"schema_462"},{"name":"state.destroyedReason","in":"query","schemaId":"schema_463"},{"name":"currency","in":"query","schemaId":"schema_464","description":"Filter by the managed account/card currency.\n\nCurrencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.\n"},{"name":"type","in":"query","schemaId":"schema_487","description":"Filter by the type of the card."},{"name":"renewalType","in":"query","schemaId":"schema_488","description":"Filter by the renewal type of the card."},{"name":"externalHandle","in":"query","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search by the card's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalHandle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"cardNumberFirstSix","in":"query","schemaId":"schema_489","description":"Filter by first six digits of the card."},{"name":"cardNumberLastFour","in":"query","schemaId":"schema_490","description":"Filter by last four digits of the card."},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for managed accounts/cards created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for managed accounts/cards created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards."},"children":[]}]}]}]},{"name":"mode","in":"query","schemaId":"schema_491","description":"Filter by card mode (prepaid mode or debit mode)."},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card."},{"name":"parentManagedAccountId","in":"query","schemaId":"components/schemas/Id","description":"Filter by the Id of the parent managed account associated with the card. This is applicable only for debit mode cards."},{"name":"manufacturingState","in":"query","schemaId":"schema_492"},{"name":"userId","in":"query","schemaId":"schema_382","description":"The unique identifier for the user."}],"pointer":"/paths/~1managed_cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"friendlyName","in":"query","required":false,"schemaId":"schema_460"},{"name":"state","in":"query","required":false,"schemaId":"schema_461"},{"name":"state.blockedReason","in":"query","required":false,"schemaId":"schema_462"},{"name":"state.destroyedReason","in":"query","required":false,"schemaId":"schema_463"},{"name":"currency","in":"query","required":false,"schemaId":"components/schemas/Currency"},{"name":"type","in":"query","required":false,"schemaId":"schema_487"},{"name":"renewalType","in":"query","required":false,"schemaId":"schema_488"},{"name":"externalHandle","in":"query","required":false,"schemaId":"schema_359"},{"name":"cardNumberFirstSix","in":"query","required":false,"schemaId":"schema_489"},{"name":"cardNumberLastFour","in":"query","required":false,"schemaId":"schema_490"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"mode","in":"query","required":false,"schemaId":"schema_491"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"},{"name":"parentManagedAccountId","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"manufacturingState","in":"query","required":false,"schemaId":"schema_492"},{"name":"userId","in":"query","required":false,"schemaId":"components/schemas/Id"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/managed_cards","href":"managed-cards/managedcardsget","openApiOperationId":"managedCardsGet","summary":"Get all managed cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}},"schemaId":"schema_493","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_493","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_493"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardsget"}],"panels":[]}]},"httpPath":"/managed_cards"},{"label":"Get a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardget","routeSlug":"/products/multi/openapi/managed-cards/managedcardget","metadata":{"seo":{"title":"Get a managed card","description":"Returns all details of the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardGet","name":"Get a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed 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":"Returns all details of the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}","href":"managed-cards/managedcardget","openApiOperationId":"managedCardGet","summary":"Get a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardget"}],"panels":[]}]},"httpPath":"/managed_cards/{id}"},{"label":"Update a managed card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardupdate","routeSlug":"/products/multi/openapi/managed-cards/managedcardupdate","metadata":{"seo":{"title":"Update a managed card","description":"Update the details of the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardUpdate","name":"Update a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a managed 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":"Update the details of the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_494"}},"schemaId":"schema_494","pointer":"/paths/~1managed_cards~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/managed_cards/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_494"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}","href":"managed-cards/managedcardupdate","openApiOperationId":"managedCardUpdate","summary":"Update a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_494","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_494"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_495"}},"schemaId":"schema_495"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_495","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_495"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardupdate"}],"panels":[]}]},"httpPath":"/managed_cards/{id}"},{"label":"Block a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardblock","metadata":{"seo":{"title":"Block a managed card","description":"Blocks the managed card identified by the id path parameter. This is a reversible action and the card can be unblocked using the managedCardUnblock operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardBlock","name":"Block a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1block/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block a managed 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":"Blocks the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. This is a reversible action and the card can be unblocked using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"managedCardUnblock"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a managed card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1block/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1block/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/block","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/block","href":"managed-cards/managedcardblock","openApiOperationId":"managedCardBlock","summary":"Block a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}},"schemaId":"schema_496"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_496","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_496"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardblock"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/block"},{"label":"Unblock a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardunblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardunblock","metadata":{"seo":{"title":"Unblock a managed card","description":"Unblocks the managed card identified by the id path parameter.The managed card must have state.blockedReason as USER so that it can be unblocked.If the managed card was blocked by SYSTEM, users cannot unblock it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardUnblock","name":"Unblock a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1unblock/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock a managed 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":"Unblocks the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The managed card must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state.blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so that it can be unblocked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the managed card was blocked by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SYSTEM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users cannot unblock it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1unblock/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1unblock/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/unblock","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/unblock","href":"managed-cards/managedcardunblock","openApiOperationId":"managedCardUnblock","summary":"Unblock a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_497"}},"schemaId":"schema_497"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1unblock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_497","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_497"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardunblock"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/unblock"},{"label":"Remove a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardremove","routeSlug":"/products/multi/openapi/managed-cards/managedcardremove","metadata":{"seo":{"title":"Remove a managed card","description":"Destroys the managed card identified by the id path parameter. Unlike block, this action is not reversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardRemove","name":"Remove a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1remove/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a managed 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":"Destroys the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. Unlike block, this action is not reversible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A managed card must be empty before it can be destroyed using this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a managed card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1remove/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/remove","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/remove","href":"managed-cards/managedcardremove","openApiOperationId":"managedCardRemove","summary":"Remove a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_498"}},"schemaId":"schema_498"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_498","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_498"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardremove"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/remove"},{"label":"Get a managed card statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardstatement","routeSlug":"/products/multi/openapi/managed-cards/managedcardstatement","metadata":{"seo":{"title":"Get a managed card statement","description":"Returns a statement for the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardStatement","name":"Get a managed card statement","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1statement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed card 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":"Returns a statement for the managed card identified by the id path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement contains only posted/completed transactions where funds have definitively moved. Pre-paid mode cards hold their own balance and so the openingBalance, closingBalance and balanceAfter refer only to the requested card. This endpoint is not available for debit-mode cards. A debit-mode card is an access instrument to the parent Managed Account and does not hold a balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In progress transactions (authorisations) are not included but can be retrieved via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.weavr.io/products/multi/openapi/managed-cards/managedcardtransactionsget#tag/Managed-Cards/operation/managedCardTransactionsGet"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction activity endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_473","description":"The maximum number of statement entries to return. Limit is capped at 500."},{"name":"startPeriod","in":"query","schemaId":"schema_465","description":"Start of the statement period. Epoch timestamp using millisecond precision."},{"name":"endPeriod","in":"query","schemaId":"schema_465","description":"End of the statement period. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"schema_474","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first (default for statements)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]},{"name":"transaction.type","in":"query","schemaId":"schema_475","description":"Filter statement entries by one or more transaction types."},{"name":"executingAccessInstrument.id","in":"query","schemaId":"components/schemas/Id","description":"Filter statement entries by the ID of the access instrument that initiated the transaction."},{"name":"executingAccessInstrument.type","in":"query","schemaId":"schema_476","description":"Filter statement entries by the type of access instrument that initiated the transaction (managed cards or IBANs)."}],"pointer":"/paths/~1managed_cards~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]},{"name":"x-api-version","in":"header","schemaId":"schema_477","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opts the call in to the latest version of the endpoint. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LATEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be routed to the newest implementation; omit to retain the default routing for your tenant."},"children":[]}]}]}]}],"pointer":"/paths/~1managed_cards~1{id}~1statement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}/statement","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_473"},{"name":"startPeriod","in":"query","required":false,"schemaId":"schema_465"},{"name":"endPeriod","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"transaction.type","in":"query","required":false,"schemaId":"schema_475"},{"name":"executingAccessInstrument.id","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"executingAccessInstrument.type","in":"query","required":false,"schemaId":"schema_476"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"},{"name":"x-api-version","in":"header","required":false,"schemaId":"schema_477"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}/statement","href":"managed-cards/managedcardstatement","openApiOperationId":"managedCardStatement","summary":"Get a managed card statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"},"application/pdf":{"schemaId":"schema_478"}},"schemaId":"components/schemas/StatementResponse","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1statement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json","application/pdf"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"},"application/pdf":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardstatement"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/statement"},{"label":"Get transaction activity for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardtransactionsget","routeSlug":"/products/multi/openapi/managed-cards/managedcardtransactionsget","metadata":{"seo":{"title":"Get transaction activity for a managed card","description":"Returns all transactional activity on the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardTransactionsGet","name":"Get transaction activity for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction activity for a managed 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":"Returns all transactional activity on the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes pending authorisations, completed settlements, refunds, and all other card transaction types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in a unified schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed card.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"type","in":"query","schemaId":"schema_479","description":"Filter by one or more transaction activity types."},{"name":"status","in":"query","schemaId":"schema_480","description":"Filter by one or more normalised transaction statuses."},{"name":"direction","in":"query","schemaId":"schema_481","description":"Filter by transaction direction (CREDIT or DEBIT)."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision."},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated after this timestamp. Useful for pulling recently changed transactions. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated before this timestamp. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_482","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort transaction activity results by. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1managed_cards~1{id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}/transactions","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"type","in":"query","required":false,"schemaId":"schema_479"},{"name":"status","in":"query","required":false,"schemaId":"schema_480"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/TransactionActivityDirection"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/TransactionActivitySortBy"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}/transactions","href":"managed-cards/managedcardtransactionsget","openApiOperationId":"managedCardTransactionsGet","summary":"Get transaction activity for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityList"}},"schemaId":"components/schemas/InstrumentTransactionActivityList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentTransactionActivityList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardtransactionsget"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/transactions"},{"label":"Get a specific transaction for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardtransactionget","routeSlug":"/products/multi/openapi/managed-cards/managedcardtransactionget","metadata":{"seo":{"title":"Get a specific transaction for a managed card","description":"Returns a specific transaction on the managed card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardTransactionGet","name":"Get a specific transaction for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific transaction for a managed card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific transaction on the managed card."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the managed card.","required":true},{"name":"transactionId","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the transaction.","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}/transactions/{transactionId}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"transactionId","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}/transactions/{transactionId}","href":"managed-cards/managedcardtransactionget","openApiOperationId":"managedCardTransactionGet","summary":"Get a specific transaction for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityItem"}},"schemaId":"components/schemas/InstrumentTransactionActivityItem","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstrumentTransactionActivityItem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstrumentTransactionActivityItem"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardtransactionget"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/transactions/{transactionId}"},{"label":"Upgrade a card to physical","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalupgrade","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalupgrade","metadata":{"seo":{"title":"Upgrade a card to physical","description":"Upgrades the virtual card identified by the id path parameter to physical."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalUpgrade","name":"Upgrade a card to physical","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upgrade a card to physical","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":"Upgrades the virtual card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter to physical."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before cards can be upgraded, a physical card programme must be set up and the card profile configuration updated accordingly."},"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":"deliveryAddress.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":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requests specifying any other delivery method (or omitting it) for a US delivery address will be rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIRES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax error on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Alternatively, programmes may be configured to automatically convert the delivery method to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COURIER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for US delivery addresses instead of rejecting the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_499"}},"schemaId":"schema_499","pointer":"/paths/~1managed_cards~1{id}~1physical/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_499"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical","href":"managed-cards/managedcardphysicalupgrade","openApiOperationId":"managedCardPhysicalUpgrade","summary":"Upgrade a card to physical"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_499","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_499"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}},"schemaId":"schema_500"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_500"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalupgrade"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical"},{"label":"Activate a physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalactivate","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalactivate","metadata":{"seo":{"title":"Activate a physical card","description":"Activates the physical card identified by the id path paramter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalActivate","name":"Activate a physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1activate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a physical 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":"Activates the physical card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path paramter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1activate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1activate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_501"}},"schemaId":"schema_501","pointer":"/paths/~1managed_cards~1{id}~1physical~1activate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/activate","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_501"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/activate","href":"managed-cards/managedcardphysicalactivate","openApiOperationId":"managedCardPhysicalActivate","summary":"Activate a physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_501","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_501"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_502"}},"schemaId":"schema_502"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_502"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalactivate"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/activate"},{"label":"Get PIN for a physical card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalpinget","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalpinget","metadata":{"seo":{"title":"Get PIN for a physical card","description":"Retrieves the PIN of the physical card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalPinGet","name":"Get PIN for a physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get PIN for a physical 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":"Retrieves the PIN of the physical card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}/physical/pin","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/pin","href":"managed-cards/managedcardphysicalpinget","openApiOperationId":"managedCardPhysicalPinGet","summary":"Get PIN for a physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}},"schemaId":"schema_503","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_504"}},"schemaId":"schema_504"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_503","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_504","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_504"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalpinget"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/pin"},{"label":"Unblock PIN for a physical card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalpinunblock","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalpinunblock","metadata":{"seo":{"title":"Unblock PIN for a physical card","description":"Physical cards can be marked as pinBlocked if there are too many failed PIN attempts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalPinUnBlock","name":"Unblock PIN for a physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin~1unblock/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock PIN for a physical 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":"Physical cards can be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pinBlocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are too many failed PIN attempts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation to unblock a PIN so that the card can be used again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin~1unblock/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/managed_cards/{id}/physical/pin/unblock","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/pin/unblock","href":"managed-cards/managedcardphysicalpinunblock","openApiOperationId":"managedCardPhysicalPinUnBlock","summary":"Unblock PIN for a physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}},"schemaId":"schema_505"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1pin~1unblock/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_505","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalpinunblock"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/pin/unblock"},{"label":"Replace a damaged physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreplacedamaged","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreplacedamaged","metadata":{"seo":{"title":"Replace a damaged physical card","description":"Report as damaged, and replace the physical card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalReplaceDamaged","name":"Replace a damaged physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_damaged/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a damaged physical 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":"Report as damaged, and replace the physical card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_damaged/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_damaged/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_506"}},"schemaId":"schema_506","pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_damaged/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/replace_damaged","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_506"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/replace_damaged","href":"managed-cards/managedcardphysicalreplacedamaged","openApiOperationId":"managedCardPhysicalReplaceDamaged","summary":"Replace a damaged physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_506","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_506"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_507"}},"schemaId":"schema_507"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_damaged/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_507","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_507"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalreplacedamaged"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/replace_damaged"},{"label":"Report a physical card as lost","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreportlost","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreportlost","metadata":{"seo":{"title":"Report a physical card as lost","description":"Report the physical card identified by the id path parameter as lost. This will deactivate the instrument and a new card will need to be requested."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalReportLost","name":"Report a physical card as lost","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_lost/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a physical card as lost","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":"Report the physical card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter as lost. This will deactivate the instrument and a new card will need to be requested."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_lost/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_lost/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/report_lost","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/report_lost","href":"managed-cards/managedcardphysicalreportlost","openApiOperationId":"managedCardPhysicalReportLost","summary":"Report a physical card as lost"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}},"schemaId":"schema_508"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_lost/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_508","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalreportlost"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/report_lost"},{"label":"Report a physical card as stolen","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreportstolen","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreportstolen","metadata":{"seo":{"title":"Report a physical card as stolen","description":"Report the physical card identified by the id path parameter as stolen. This will destroy the instrument and a new replacement card will need to be requested."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalReportStolen","name":"Report a physical card as stolen","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_stolen/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report a physical card as stolen","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":"Report the physical card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter as stolen. This will destroy the instrument and a new replacement card will need to be requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a replacement is requested, any funds remaining on this destroyed card will be transferred to the replacement card.\""},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_stolen/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_stolen/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/report_stolen","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/report_stolen","href":"managed-cards/managedcardphysicalreportstolen","openApiOperationId":"managedCardPhysicalReportStolen","summary":"Report a physical card as stolen"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_509"}},"schemaId":"schema_509"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1report_stolen/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_509","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_509"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalreportstolen"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/report_stolen"},{"label":"Replace a lost or stolen physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalreplacelostorstolen","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalreplacelostorstolen","metadata":{"seo":{"title":"Replace a lost or stolen physical card","description":"Issue a replacement for the physical card, identified by the id path parameter, that has already been reported as lost or stolen."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalReplaceLostOrStolen","name":"Replace a lost or stolen physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_lost_stolen/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a lost or stolen physical 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":"Issue a replacement for the physical card, identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter, that has already been reported as lost or stolen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any funds (that are not blocked pending a purchase for a previous authorisation) remaining on the card will be automatically transferred to the new replacement card."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_lost_stolen/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_lost_stolen/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510","pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_lost_stolen/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/replace_lost_stolen","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_510"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/replace_lost_stolen","href":"managed-cards/managedcardphysicalreplacelostorstolen","openApiOperationId":"managedCardPhysicalReplaceLostOrStolen","summary":"Replace a lost or stolen physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_510"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}},"schemaId":"components/schemas/ManagedCard","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_511"}},"schemaId":"schema_511"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1replace_lost_stolen/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManagedCard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManagedCard"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_511","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_511"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalreplacelostorstolen"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/replace_lost_stolen"},{"label":"Reset contactless limit for a physical card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardphysicalcontactlesslimitreset","routeSlug":"/products/multi/openapi/managed-cards/managedcardphysicalcontactlesslimitreset","metadata":{"seo":{"title":"Reset contactless limit for a physical card","description":"For security purposes, the cardholder needs to provide the PIN after a number of contactless purchases. Use this operation to reset the physical card's contactless limit. The contactless limit can only be reset for physical cards having the wearable form factor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardPhysicalContactlessLimitReset","name":"Reset contactless limit for a physical card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1physical~1contactless_limit~1reset/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset contactless limit for a physical card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For security purposes, the cardholder needs to provide the PIN after a number of contactless purchases. Use this operation to reset the physical card's contactless limit.\nThe contactless limit can only be reset for physical cards having the wearable form factor.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1contactless_limit~1reset/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1contactless_limit~1reset/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/physical/contactless_limit/reset","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/physical/contactless_limit/reset","href":"managed-cards/managedcardphysicalcontactlesslimitreset","openApiOperationId":"managedCardPhysicalContactlessLimitReset","summary":"Reset contactless limit for a physical card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}},"schemaId":"schema_512"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1physical~1contactless_limit~1reset/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_512","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardphysicalcontactlesslimitreset"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/physical/contactless_limit/reset"},{"label":"Get a managed card statement (legacy)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/managed-cards/managedcardstatementdeprecated","routeSlug":"/products/multi/openapi/managed-cards/managedcardstatementdeprecated","metadata":{"seo":{"title":"Get a managed card statement (legacy)","description":"Deprecated in favour of GET /managed_cards/{id}/statements, which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our changelog."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardStatementDeprecated","name":"Get a managed card statement (legacy)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1deprecated~1managed_cards~1{id}~1statement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a managed card statement (legacy)","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.weavr.io/products/multi/openapi/managed-cards/managedcardstatement#tag/Managed-Cards/operation/managedCardStatements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /managed_cards/{id}/statements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which provides an authoritative, immutable statement of record for an instrument over a period, as explained in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.weavr.io/changelog/2026/06/23/multi/release-113/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changelog"},"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 endpoint returns a list of transactions (in our legacy format) for a managed card, identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter, matching the criteria provided in the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a managed card.","required":true}],"pointer":"/paths/~1deprecated~1managed_cards~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"statementLimit","in":"query","schemaId":"schema_473","description":"The limit of the results for statements paging, starting at the offset. Limit is capped at 500."},{"name":"orderByTimestamp","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders the result in ascending or descending 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":"ASC: Ascending order, oldest transactions first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent transactions first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not specified, the transactions will be returned in descending order."},"children":[]}]}]}]},{"name":"fromTimestamp","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transactions having transaction timestamp after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included."},"children":[]}]}]}]},{"name":"toTimestamp","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transactions having transaction timestamp before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Timestamp is expressed in Epoch timestamp using millisecond precision. If omitted, all matching transactions up to the present will be included. If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"singleEntryPerTransaction","in":"query","schemaId":"schema_378","description":"Returns transactions that span multiple movements as a single entry.\nOnly includes transactions that have been completed.\nDefaults to true for PDF statements, false otherwise.\nNote: due to the fact that only completed transactions are included, some\ntransactions that are in progress and have modified the balance of the instrument\nwill not be shown, which could lead to seemingly inconsistent balance being displayed.\n"},{"name":"transactionType","in":"query","schemaId":"schema_484","description":"Filter by the transaction type. Leave out to fetch all entries."}],"pointer":"/paths/~1deprecated~1managed_cards~1{id}~1statement/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]}],"pointer":"/paths/~1deprecated~1managed_cards~1{id}~1statement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deprecated/managed_cards/{id}/statement","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"statementLimit","in":"query","required":false,"schemaId":"schema_473"},{"name":"orderByTimestamp","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"fromTimestamp","in":"query","required":false,"schemaId":"schema_465"},{"name":"toTimestamp","in":"query","required":false,"schemaId":"schema_465"},{"name":"singleEntryPerTransaction","in":"query","required":false,"schemaId":"schema_378"},{"name":"transactionType","in":"query","required":false,"schemaId":"schema_484"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/deprecated/managed_cards/{id}/statement","href":"managed-cards/managedcardstatementdeprecated","openApiOperationId":"managedCardStatementDeprecated","summary":"Get a managed card statement (legacy)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json","application/pdf","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"},"application/pdf":{"schemaId":"schema_478"},"text/csv":{"schemaId":"schema_485"}},"schemaId":"components/schemas/Statement","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1deprecated~1managed_cards~1{id}~1statement/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json","application/pdf","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"},"application/pdf":{"schemaId":"schema_478"},"text/csv":{"schemaId":"schema_485"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managedcardstatementdeprecated"}],"panels":[]}]},"httpPath":"/deprecated/managed_cards/{id}/statement"}],"content":{"contentType":"group","meta":{"name":"Managed Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managed Cards","showPageActions":true},{"nodeType":"markdoc","content":"Managed Cards are a type of financial instrument offered by Weavr.\n\nYou can create virtual or physical cards that are issued to the consumer or corporate identity.\n\nA card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/managed_cards","summary":"Create a managed card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardcreate","deprecated":false},{"title":"/managed_cards","summary":"Get all managed cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardsget","deprecated":false},{"title":"/managed_cards/{id}","summary":"Get a managed card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardget","deprecated":false},{"title":"/managed_cards/{id}","summary":"Update a managed card","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/managed-cards/managedcardupdate","deprecated":false},{"title":"/managed_cards/{id}/block","summary":"Block a managed card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardblock","deprecated":false},{"title":"/managed_cards/{id}/unblock","summary":"Unblock a managed card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardunblock","deprecated":false},{"title":"/managed_cards/{id}/remove","summary":"Remove a managed card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardremove","deprecated":false},{"title":"/managed_cards/{id}/statement","summary":"Get a managed card statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardstatement","deprecated":false},{"title":"/managed_cards/{id}/transactions","summary":"Get transaction activity for a managed card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardtransactionsget","deprecated":false},{"title":"/managed_cards/{id}/transactions/{transactionId}","summary":"Get a specific transaction for a managed card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardtransactionget","deprecated":false},{"title":"/managed_cards/{id}/physical","summary":"Upgrade a card to physical","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalupgrade","deprecated":false},{"title":"/managed_cards/{id}/physical/activate","summary":"Activate a physical card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalactivate","deprecated":false},{"title":"/managed_cards/{id}/physical/pin","summary":"Get PIN for a physical card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managed-cards/managedcardphysicalpinget","deprecated":false},{"title":"/managed_cards/{id}/physical/pin/unblock","summary":"Unblock PIN for a physical card","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/managed-cards/managedcardphysicalpinunblock","deprecated":false},{"title":"/managed_cards/{id}/physical/replace_damaged","summary":"Replace a damaged physical card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalreplacedamaged","deprecated":false},{"title":"/managed_cards/{id}/physical/report_lost","summary":"Report a physical card as lost","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalreportlost","deprecated":false},{"title":"/managed_cards/{id}/physical/report_stolen","summary":"Report a physical card as stolen","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalreportstolen","deprecated":false},{"title":"/managed_cards/{id}/physical/replace_lost_stolen","summary":"Replace a lost or stolen physical card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalreplacelostorstolen","deprecated":false},{"title":"/managed_cards/{id}/physical/contactless_limit/reset","summary":"Reset contactless limit for a physical card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managedcardphysicalcontactlesslimitreset","deprecated":false},{"title":"/deprecated/managed_cards/{id}/statement","summary":"Get a managed card statement (legacy)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/managed-cards/managedcardstatementdeprecated","deprecated":true}]}]}]}]}},{"type":"separator","label":"Funds Management","content":null},{"type":"group","label":"Transfers","link":"/products/multi/openapi/transfers","routeSlug":"/products/multi/openapi/transfers","items":[{"label":"Create a transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfercreate","routeSlug":"/products/multi/openapi/transfers/transfercreate","metadata":{"seo":{"title":"Create a transfer transaction","description":"Transfers funds between managed accounts and managed cards belonging to the same corporate or consumer identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferCreate","name":"Create a transfer transaction","isWebhook":false,"pointer":"/paths/~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transfer transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers funds between managed accounts and managed cards belonging to the same corporate or consumer identity.\n\nThe Transfer Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"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_513"}},"schemaId":"schema_513","pointer":"/paths/~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_513"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/transfers","href":"transfers/transfercreate","openApiOperationId":"transferCreate","summary":"Create a transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_513","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_513"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transfer"}},"schemaId":"components/schemas/Transfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"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":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/transfercreate"}],"panels":[]}]},"httpPath":"/transfers"},{"label":"Get all transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfersget","routeSlug":"/products/multi/openapi/transfers/transfersget","metadata":{"seo":{"title":"Get all transfer transactions","description":"Retrieves all the transfer transactions performed by the logged-in identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transfersGet","name":"Get all transfer transactions","isWebhook":false,"pointer":"/paths/~1transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all transfer transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the transfer transactions performed by the logged-in identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the transfer profile. Leave out to fetch all transfer transactions."},{"name":"instrumentId","in":"query","schemaId":"schema_515","description":"Filter by the source instrument id."},{"name":"state","in":"query","schemaId":"schema_516","description":"Filter by the transfer transaction state. Leave out to fetch all states."},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transfer transactions created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transfer transactions created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers."},"children":[]}]}]}]},{"name":"executedFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transfer transactions executed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers."},"children":[]}]}]}]},{"name":"executedTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for transfer transactions executed before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all transfers."},"children":[]}]}]}]},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the transfer tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries."}],"pointer":"/paths/~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"instrumentId","in":"query","required":false,"schemaId":"components/schemas/InstrumentId"},{"name":"state","in":"query","required":false,"schemaId":"schema_516"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/transfers","href":"transfers/transfersget","openApiOperationId":"transfersGet","summary":"Get all transfer transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_517"}},"schemaId":"schema_517","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_517","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_517"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/transfersget"}],"panels":[]}]},"httpPath":"/transfers"},{"label":"Cancel transfer transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transfercancel","routeSlug":"/products/multi/openapi/transfers/transfercancel","metadata":{"seo":{"title":"Cancel transfer transactions","description":"Cancels transfers that are scheduled to be executed in the future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferCancel","name":"Cancel transfer transactions","isWebhook":false,"pointer":"/paths/~1transfers~1bulk~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel transfer transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels transfers that are scheduled to be executed in the future."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionBulkCancelRequest"}},"schemaId":"components/schemas/TransactionBulkCancelRequest","pointer":"/paths/~1transfers~1bulk~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers/bulk/cancel","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionBulkCancelRequest"}},"responseCodes":["200","400","401","429","500","503","default"],"pointer":"/transfers/bulk/cancel","href":"transfers/transfercancel","openApiOperationId":"transferCancel","summary":"Cancel transfer transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransactionBulkCancelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionBulkCancelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionBulkCancelResponse"}},"schemaId":"components/schemas/TransactionBulkCancelResponse","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1transfers~1bulk~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionBulkCancelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionBulkCancelResponse"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/transfercancel"}],"panels":[]}]},"httpPath":"/transfers/bulk/cancel"},{"label":"Get a transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transfers/transferget","routeSlug":"/products/multi/openapi/transfers/transferget","metadata":{"seo":{"title":"Get a transfer transaction","description":"Retrieve the transfer transaction identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferGet","name":"Get a transfer transaction","isWebhook":false,"pointer":"/paths/~1transfers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transfer 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 the transfer transaction identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Transfer transaction.","required":true}],"pointer":"/paths/~1transfers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/transfers/{id}","href":"transfers/transferget","openApiOperationId":"transferGet","summary":"Get a transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transfer"}},"schemaId":"components/schemas/Transfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1transfers~1{id}/get/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":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/transferget"}],"panels":[]}]},"httpPath":"/transfers/{id}"}],"content":{"contentType":"group","meta":{"name":"Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","showPageActions":true},{"nodeType":"markdoc","content":"The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers","summary":"Create a transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/transfercreate","deprecated":false},{"title":"/transfers","summary":"Get all transfer transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/transfersget","deprecated":false},{"title":"/transfers/bulk/cancel","summary":"Cancel transfer transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/transfercancel","deprecated":false},{"title":"/transfers/{id}","summary":"Get a transfer transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/transferget","deprecated":false}]}]}]}]}},{"type":"group","label":"Transaction Activity","link":"/products/multi/openapi/transaction-activity","routeSlug":"/products/multi/openapi/transaction-activity","items":[{"label":"Get all transaction activity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/transaction-activity/transactionsget","routeSlug":"/products/multi/openapi/transaction-activity/transactionsget","metadata":{"seo":{"title":"Get all transaction activity","description":"Returns all transactional activity across all managed accounts and managed cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transactionsGet","name":"Get all transaction activity","isWebhook":false,"pointer":"/paths/~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all transaction activity","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 transactional activity across all managed accounts and managed cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This provides a single view of all transfers, sends, wire transfers, card payments, fees, and other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction types regardless of which wallet they belong to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is when the transaction was created in its owning service (the same value the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object reports), and is the field the creation-window filter applies to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions that are committed but not yet executed (e.g. scheduled wire transfers) appear with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMITTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; such transactions never appear on statements until they execute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transfer between two of the caller's own instruments (e.g. between a managed account and a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"managed card belonging to the same identity) returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries — a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the source"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrument and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the destination instrument — which share the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and differ by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Treat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(id, instrument)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the key when reconciling, and note that such a transfer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contributes 2 to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The per-instrument activity endpoints"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/managed_accounts/{id}/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/managed_cards/{id}/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are scoped to one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instrument and so still show the single relevant side."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"type","in":"query","schemaId":"schema_479","description":"Filter by one or more transaction activity types."},{"name":"status","in":"query","schemaId":"schema_480","description":"Filter by one or more normalised transaction statuses."},{"name":"direction","in":"query","schemaId":"schema_481","description":"Filter by transaction direction (CREDIT or DEBIT)."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision."},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated after this timestamp. Useful for pulling recently changed transactions. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated before this timestamp. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_482","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort transaction activity results by. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"type","in":"query","required":false,"schemaId":"schema_479"},{"name":"status","in":"query","required":false,"schemaId":"schema_480"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/TransactionActivityDirection"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"},{"name":"sortBy","in":"query","required":false,"schemaId":"components/schemas/TransactionActivitySortBy"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/transactions","href":"transaction-activity/transactionsget","openApiOperationId":"transactionsGet","summary":"Get all transaction activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionActivityList"}},"schemaId":"components/schemas/TransactionActivityList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionActivityList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionActivityList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-activity/transactionsget"}],"panels":[]}]},"httpPath":"/transactions"}],"content":{"contentType":"group","meta":{"name":"Transaction Activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction Activity","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve the consolidated transaction activity across instruments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions","summary":"Get all transaction activity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction-activity/transactionsget","deprecated":false}]}]}]}]}},{"type":"separator","label":"External Payments","content":null},{"type":"group","label":"Incoming Wire Transfers","link":"/products/multi/openapi/incoming-wire-transfers","routeSlug":"/products/multi/openapi/incoming-wire-transfers","items":[{"label":"Get all incoming wire transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransfersget","routeSlug":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransfersget","metadata":{"seo":{"title":"Get all incoming wire transfers","description":"Returns all incoming wire transfers for the authenticated identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"incomingWireTransfersGet","name":"Get all incoming wire transfers","isWebhook":false,"pointer":"/paths/~1incoming_wire_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all incoming wire transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all incoming wire transfers for the authenticated identity.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"state","in":"query","schemaId":"schema_518","description":"Filter incoming wire transfers by state."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision."},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated after this timestamp. Useful for pulling recently changed transactions. Epoch timestamp using millisecond precision."},{"name":"lastUpdatedTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions last updated before this timestamp. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]}],"pointer":"/paths/~1incoming_wire_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/incoming_wire_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"state","in":"query","required":false,"schemaId":"schema_518"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/incoming_wire_transfers","href":"incoming-wire-transfers/incomingwiretransfersget","openApiOperationId":"incomingWireTransfersGet","summary":"Get all incoming wire transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IncomingWireTransferList"}},"schemaId":"components/schemas/IncomingWireTransferList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1incoming_wire_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IncomingWireTransferList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IncomingWireTransferList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-wire-transfers/incomingwiretransfersget"}],"panels":[]}]},"httpPath":"/incoming_wire_transfers"},{"label":"Get an incoming wire transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransferget","routeSlug":"/products/multi/openapi/incoming-wire-transfers/incomingwiretransferget","metadata":{"seo":{"title":"Get an incoming wire transfer","description":"Returns a specific incoming wire transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"incomingWireTransferGet","name":"Get an incoming wire transfer","isWebhook":false,"pointer":"/paths/~1incoming_wire_transfers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an incoming wire transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a specific incoming wire transfer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the incoming wire transfer.","required":true}],"pointer":"/paths/~1incoming_wire_transfers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/incoming_wire_transfers/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/incoming_wire_transfers/{id}","href":"incoming-wire-transfers/incomingwiretransferget","openApiOperationId":"incomingWireTransferGet","summary":"Get an incoming wire transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IncomingWireTransfer"}},"schemaId":"components/schemas/IncomingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1incoming_wire_transfers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/IncomingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IncomingWireTransfer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-wire-transfers/incomingwiretransferget"}],"panels":[]}]},"httpPath":"/incoming_wire_transfers/{id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Approve or reject incoming wire transfers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/multi/openapi/incoming-wire-transfers/banktransferinforwarding","routeSlug":"/products/multi/openapi/incoming-wire-transfers/banktransferinforwarding","metadata":{"seo":{"title":"Approve or reject incoming wire transfers","description":"Approve or reject incoming wire transfers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bankTransferInForwarding","name":"Approve or reject incoming wire transfers","isWebhook":true,"pointer":"/paths/~1bank_transfers_in~1authorisation_request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve or reject incoming wire transfers","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"webhooks_key","scopes":[],"type":"apiKey","in":"header","paramName":"webhooks-key","description":"The Webhooks key can be found in the API Credentials tab in your Portal Page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"request-ref","in":"header","schemaId":"schema_359","description":"A unique call reference included in every call, that enables the receiver to avoid duplicate handling of a webhook request (e.g. webhook was resent)."},{"name":"published-timestamp","in":"header","schemaId":"schema_465","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1bank_transfers_in~1authorisation_request/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519","pointer":"/paths/~1bank_transfers_in~1authorisation_request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/bank_transfers_in/authorisation_request","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"request-ref","in":"header","required":false,"schemaId":"schema_359"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_465","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_359","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_359","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"webhooks_key","type":"apiKey","name":"webhooks-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_519"}},"responseCodes":["200","404","default"],"pointer":"/bank_transfers_in/authorisation_request","href":"incoming-wire-transfers/banktransferinforwarding","openApiOperationId":"bankTransferInForwarding","summary":"Approve or reject incoming wire transfers"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_519"}},"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":"Authorisation event received with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decision."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bank_transfers_in~1authorisation_request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incoming-wire-transfers/banktransferinforwarding"}],"panels":[]}]},"httpPath":"/bank_transfers_in/authorisation_request"}],"content":{"contentType":"group","meta":{"name":"Incoming Wire Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incoming Wire Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Incoming wire transfers received from external bank accounts to managed accounts with IBANs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/incoming_wire_transfers","summary":"Get all incoming wire transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incoming-wire-transfers/incomingwiretransfersget","deprecated":false},{"title":"/incoming_wire_transfers/{id}","summary":"Get an incoming wire transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incoming-wire-transfers/incomingwiretransferget","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/bank_transfers_in/authorisation_request","summary":"Approve or reject incoming wire transfers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incoming-wire-transfers/banktransferinforwarding","deprecated":false}]}]}]}]}},{"type":"group","label":"Outgoing Wire Transfers","link":"/products/multi/openapi/outgoing-wire-transfers","routeSlug":"/products/multi/openapi/outgoing-wire-transfers","items":[{"label":"Create an outgoing wire transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfercreate","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfercreate","metadata":{"seo":{"title":"Create an outgoing wire transfer","description":"Transfers funds from managed accounts to an external bank account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferCreate","name":"Create an outgoing wire transfer","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an outgoing wire transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers funds from managed accounts to an external bank account.\n\nThe Outgoing Wire Transfer Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees).\n\nNote that even if the transaction is created successfully, you still need to check its state in order to determine if it is pending completion of an authentication challenge by the user. \n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1outgoing_wire_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferCreateRequest"}},"schemaId":"components/schemas/OutgoingWireTransferCreateRequest","pointer":"/paths/~1outgoing_wire_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferCreateRequest"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/outgoing_wire_transfers","href":"outgoing-wire-transfers/outgoingwiretransfercreate","openApiOperationId":"outgoingWireTransferCreate","summary":"Create an outgoing wire transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/OutgoingWireTransferCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}},"schemaId":"components/schemas/OutgoingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1outgoing_wire_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutgoingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_521"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransfercreate"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers"},{"label":"Get all outgoing wire transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersget","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersget","metadata":{"seo":{"title":"Get all outgoing wire transfer transactions","description":"Retrieves all the outgoing wire transfer transactions performed by the logged-in identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransfersGet","name":"Get all outgoing wire transfer transactions","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all outgoing wire transfer transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the outgoing wire transfer transactions performed by the logged-in identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the managed account/card profile. Leave out to fetch all managed accounts/card."},{"name":"instrument","in":"query","schemaId":"schema_522","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":"sourceInstrument.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInstrument.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Filter by the source instrument id (which must be a managed account)."},"children":[]}]}]}],"deprecated":true},{"name":"sourceInstrument.id","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument id. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"sourceInstrument.type","in":"query","schemaId":"schema_524","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument type. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_525","description":"Filter by the outgoing wire transfer state. Leave out to fetch all states."},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for outgoing wire transfer transactions created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision. Leave out to fetch all outgoing wire transfer transactions."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for Outgoing Wire Transfer transactions created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision. Leave out to fetch all outgoing wire transfer transactions."},"children":[]}]}]}]},{"name":"executedFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for outgoing wire transfer transactions executed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision. Leave out to fetch all outgoing wire transfer transactions."},"children":[]}]}]}]},{"name":"executedTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for Outgoing Wire Transfer transactions executed before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision. Leave out to fetch all outgoing wire transfer transactions."},"children":[]}]}]}]},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the outgoing wire transfer tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries."}],"pointer":"/paths/~1outgoing_wire_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outgoing_wire_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"instrument","in":"query","required":false,"schemaId":"schema_522"},{"name":"sourceInstrument.id","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"sourceInstrument.type","in":"query","required":false,"schemaId":"components/schemas/SourceInstrumentType"},{"name":"state","in":"query","required":false,"schemaId":"schema_525"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503"],"pointer":"/outgoing_wire_transfers","href":"outgoing-wire-transfers/outgoingwiretransfersget","openApiOperationId":"outgoingWireTransfersGet","summary":"Get all outgoing wire transfer transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1outgoing_wire_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransfersget"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers"},{"label":"Get an outgoing wire transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferget","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferget","metadata":{"seo":{"title":"Get an outgoing wire transfer transaction","description":"Retrieves the outgoing wire transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferGet","name":"Get an outgoing wire transfer transaction","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an outgoing wire transfer 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":"Retrieves the outgoing wire transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outgoing_wire_transfers/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503"],"pointer":"/outgoing_wire_transfers/{id}","href":"outgoing-wire-transfers/outgoingwiretransferget","openApiOperationId":"outgoingWireTransferGet","summary":"Get an outgoing wire transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}},"schemaId":"components/schemas/OutgoingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutgoingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferget"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}"},{"label":"Update the beneficiary name of an outgoing wire transfer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","metadata":{"seo":{"title":"Update the beneficiary name of an outgoing wire transfer","description":"Update the beneficiary name of an OWT in PENDING_CONFIRMATION state. Clears and re-runs CoP/VoP validation with the new name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferUpdateBeneficiaryName","name":"Update the beneficiary name of an outgoing wire transfer","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the beneficiary name of an outgoing wire 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":"Update the beneficiary name of an OWT in PENDING_CONFIRMATION state. Clears and re-runs CoP/VoP validation with the new name."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest"}},"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest","pointer":"/paths/~1outgoing_wire_transfers~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/outgoing_wire_transfers/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest"}},"responseCodes":["200","409"],"pointer":"/outgoing_wire_transfers/{id}","href":"outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","openApiOperationId":"outgoingWireTransferUpdateBeneficiaryName","summary":"Update the beneficiary name of an outgoing wire transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}},"schemaId":"components/schemas/OutgoingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Update beneficiary name conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict"}},"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutgoingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}}},{"code":"409","schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}"},{"label":"Get an outgoing wire transfer payment confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","metadata":{"seo":{"title":"Get an outgoing wire transfer payment confirmation","description":"Returns a payment-confirmation PDF for the completed outgoing wire transfer identified by the id path parameter. If the transfer was subsequently returned, the document also includes the return details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferPaymentConfirmation","name":"Get an outgoing wire transfer payment confirmation","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1payment_confirmation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an outgoing wire transfer payment confirmation","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 payment-confirmation PDF for the completed outgoing wire transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. If the transfer was subsequently returned, the document also includes the return details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1payment_confirmation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/outgoing_wire_transfers/{id}/payment_confirmation","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/outgoing_wire_transfers/{id}/payment_confirmation","href":"outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","openApiOperationId":"outgoingWireTransferPaymentConfirmation","summary":"Get an outgoing wire transfer payment confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"The outgoing wire transfer exists but is not in a state for which a payment confirmation can be produced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferPaymentConfirmationConflict"}},"schemaId":"components/schemas/OutgoingWireTransferPaymentConfirmationConflict"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1payment_confirmation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_478"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/OutgoingWireTransferPaymentConfirmationConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferPaymentConfirmationConflict"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/payment_confirmation"},{"label":"Cancel an outgoing wire transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersinglecancel","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransfersinglecancel","metadata":{"seo":{"title":"Cancel an outgoing wire transfer transaction","description":"Cancel the outgoing wire transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferSingleCancel","name":"Cancel an outgoing wire transfer transaction","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an outgoing wire transfer 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":"Cancel the outgoing wire transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"schemaId":"components/schemas/TransactionSingleCancelRequest","pointer":"/paths/~1outgoing_wire_transfers~1{id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers/{id}/cancel","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/outgoing_wire_transfers/{id}/cancel","href":"outgoing-wire-transfers/outgoingwiretransfersinglecancel","openApiOperationId":"outgoingWireTransferSingleCancel","summary":"Cancel an outgoing wire transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransactionSingleCancelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}},"schemaId":"components/schemas/OutgoingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutgoingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransfersinglecancel"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/cancel"},{"label":"Confirm an outgoing wire transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferconfirm","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferconfirm","metadata":{"seo":{"title":"Confirm an outgoing wire transfer transaction","description":"Confirm the outgoing wire transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferConfirm","name":"Confirm an outgoing wire transfer transaction","isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1confirm/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm an outgoing wire transfer 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":"Confirm the outgoing wire transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1confirm/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers/{id}/confirm","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/outgoing_wire_transfers/{id}/confirm","href":"outgoing-wire-transfers/outgoingwiretransferconfirm","openApiOperationId":"outgoingWireTransferConfirm","summary":"Confirm an outgoing wire transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}},"schemaId":"components/schemas/OutgoingWireTransfer","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutgoingWireTransfer","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransfer"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferconfirm"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/confirm"},{"label":"Issue a one-time password that can be used to verify an outgoing wire transfer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallenge","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify an outgoing wire transfer","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferSCAChallenge","name":"Issue a one-time password that can be used to verify an outgoing wire transfer","deprecated":true,"isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a one-time password that can be used to verify an outgoing wire transfer","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAChallenge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the verification process for an outgoing wire transfer in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/otp/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the outgoing wire transfer "},"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":"PENDING_CHALLENGE"},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}","href":"outgoing-wire-transfers/outgoingwiretransferscachallenge","openApiOperationId":"outgoingWireTransferSCAChallenge","summary":"Issue a one-time password that can be used to verify an outgoing wire transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferscachallenge"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}"},{"label":"Verify an outgoing wire transfer using a one-time password","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscaverify","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscaverify","metadata":{"seo":{"title":"Verify an outgoing wire transfer using a one-time password","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferSCAVerify","name":"Verify an outgoing wire transfer using a one-time password","deprecated":true,"isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify an outgoing wire transfer using a one-time password","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAVerify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completes the verification process for an outgoing wire transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the outcome of the verification is successful, the outgoing wire transfer transaction is executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not verified challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verify","href":"outgoing-wire-transfers/outgoingwiretransferscaverify","openApiOperationId":"outgoingWireTransferSCAVerify","summary":"Verify an outgoing wire transfer using a one-time password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}},"schemaId":"schema_529"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_529","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferscaverify"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify an outgoing wire transfer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallengepush","routeSlug":"/products/multi/openapi/outgoing-wire-transfers/outgoingwiretransferscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify an outgoing wire transfer","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoingWireTransferSCAChallengePush","name":"Issue a push notification that can be used to verify an outgoing wire transfer","deprecated":true,"isWebhook":false,"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1push~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a push notification that can be used to verify an outgoing wire transfer","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAChallengePush"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the verification process for an outgoing wire transfer in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/push/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the outgoing wire transfer "},"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":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Outgoing Wire Transfer transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1push~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/outgoing_wire_transfers/{id}/challenges/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/outgoing_wire_transfers/{id}/challenges/push/{channel}","href":"outgoing-wire-transfers/outgoingwiretransferscachallengepush","openApiOperationId":"outgoingWireTransferSCAChallengePush","summary":"Issue a push notification that can be used to verify an outgoing wire transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1outgoing_wire_transfers~1{id}~1challenges~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoingwiretransferscachallengepush"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/{id}/challenges/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Outgoing Wire Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Outgoing Wire Transfers","showPageActions":true},{"nodeType":"markdoc","content":"The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/outgoing_wire_transfers","summary":"Create an outgoing wire transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransfercreate","deprecated":false},{"title":"/outgoing_wire_transfers","summary":"Get all outgoing wire transfer transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransfersget","deprecated":false},{"title":"/outgoing_wire_transfers/{id}","summary":"Get an outgoing wire transfer transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferget","deprecated":false},{"title":"/outgoing_wire_transfers/{id}","summary":"Update the beneficiary name of an outgoing wire transfer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferupdatebeneficiaryname","deprecated":false},{"title":"/outgoing_wire_transfers/{id}/payment_confirmation","summary":"Get an outgoing wire transfer payment confirmation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferpaymentconfirmation","deprecated":false},{"title":"/outgoing_wire_transfers/{id}/cancel","summary":"Cancel an outgoing wire transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransfersinglecancel","deprecated":false},{"title":"/outgoing_wire_transfers/{id}/confirm","summary":"Confirm an outgoing wire transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferconfirm","deprecated":false},{"title":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}","summary":"Issue a one-time password that can be used to verify an outgoing wire transfer","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferscachallenge","deprecated":true},{"title":"/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verify","summary":"Verify an outgoing wire transfer using a one-time password","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferscaverify","deprecated":true},{"title":"/outgoing_wire_transfers/{id}/challenges/push/{channel}","summary":"Issue a push notification that can be used to verify an outgoing wire transfer","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/outgoing-wire-transfers/outgoingwiretransferscachallengepush","deprecated":true}]}]}]}]}},{"type":"group","label":"Correspondent Bank Transfers","link":"/products/multi/openapi/correspondent-bank-transfers","routeSlug":"/products/multi/openapi/correspondent-bank-transfers","items":[{"label":"Create a correspondent bank transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercreate","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercreate","metadata":{"seo":{"title":"Create a correspondent bank transfer","description":"Creates an outgoing wire transfer on behalf of an originator (correspondent banking)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondentBankTransferCreate","name":"Create a correspondent bank transfer","isWebhook":false,"pointer":"/paths/~1correspondent_bank_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a correspondent bank transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an outgoing wire transfer on behalf of an originator (correspondent banking).\n\nThis endpoint is designed for correspondent banking use cases where a financial institution\ninitiates a wire transfer on behalf of another party (the originator).\n\nThe Outgoing Wire Transfer Profile (configured in the Multi Portal) specified determines the behaviour\nand restrictions of the transaction (for example, fees).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1correspondent_bank_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwtCreateRequest"}},"schemaId":"components/schemas/CorrespondentBankingOwtCreateRequest","pointer":"/paths/~1correspondent_bank_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/correspondent_bank_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwtCreateRequest"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/correspondent_bank_transfers","href":"correspondent-bank-transfers/correspondentbanktransfercreate","openApiOperationId":"correspondentBankTransferCreate","summary":"Create a correspondent bank transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CorrespondentBankingOwtCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwtCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}},"schemaId":"components/schemas/CorrespondentBankingOwt","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1correspondent_bank_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorrespondentBankingOwt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondentbanktransfercreate"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers"},{"label":"Get all correspondent bank transfer transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfersget","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfersget","metadata":{"seo":{"title":"Get all correspondent bank transfer transactions","description":"Retrieves all correspondent bank transfer transactions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondentBankTransfersGet","name":"Get all correspondent bank transfer transactions","isWebhook":false,"pointer":"/paths/~1correspondent_bank_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all correspondent bank transfer transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all correspondent bank transfer transactions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the managed account/card profile. Leave out to fetch all managed accounts/card."},{"name":"sourceInstrument.id","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument id. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"sourceInstrument.type","in":"query","schemaId":"schema_524","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument type. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for correspondent bank transfer transactions created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for correspondent bank transfer transactions created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision."},"children":[]}]}]}]},{"name":"executedFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for correspondent bank transfer transactions executed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision."},"children":[]}]}]}]},{"name":"executedTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for correspondent bank transfer transactions executed before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, expressed in Epoch timestamp using millisecond precision."},"children":[]}]}]}]},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the correspondent bank transfer tag. The exact tag must be provided, as wildcards are not supported."},{"name":"state","in":"query","schemaId":"schema_532","description":"Filter by the state of the correspondent bank transfer transaction."},{"name":"originator.name","in":"query","schemaId":"schema_359","description":"Filter by the originator name. Partial matches are supported."},{"name":"originator.type","in":"query","schemaId":"schema_533","description":"Filter by the originator type."},{"name":"originator.tag","in":"query","schemaId":"schema_359","description":"Filter by the originator tag."}],"pointer":"/paths/~1correspondent_bank_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/correspondent_bank_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"sourceInstrument.id","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"sourceInstrument.type","in":"query","required":false,"schemaId":"components/schemas/SourceInstrumentType"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"},{"name":"state","in":"query","required":false,"schemaId":"schema_532"},{"name":"originator.name","in":"query","required":false,"schemaId":"schema_359"},{"name":"originator.type","in":"query","required":false,"schemaId":"schema_533"},{"name":"originator.tag","in":"query","required":false,"schemaId":"schema_359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503"],"pointer":"/correspondent_bank_transfers","href":"correspondent-bank-transfers/correspondentbanktransfersget","openApiOperationId":"correspondentBankTransfersGet","summary":"Get all correspondent bank transfer transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1correspondent_bank_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondentbanktransfersget"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers"},{"label":"Get a correspondent bank transfer transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferget","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferget","metadata":{"seo":{"title":"Get a correspondent bank transfer transaction","description":"Retrieves the correspondent bank transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondentBankTransferGet","name":"Get a correspondent bank transfer transaction","isWebhook":false,"pointer":"/paths/~1correspondent_bank_transfers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a correspondent bank transfer 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":"Retrieves the correspondent bank transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the correspondent bank transfer transaction.","required":true}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/correspondent_bank_transfers/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503"],"pointer":"/correspondent_bank_transfers/{id}","href":"correspondent-bank-transfers/correspondentbanktransferget","openApiOperationId":"correspondentBankTransferGet","summary":"Get a correspondent bank transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}},"schemaId":"components/schemas/CorrespondentBankingOwt","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorrespondentBankingOwt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondentbanktransferget"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers/{id}"},{"label":"Cancel a correspondent bank transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercancel","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransfercancel","metadata":{"seo":{"title":"Cancel a correspondent bank transfer transaction","description":"Cancel the correspondent bank transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondentBankTransferCancel","name":"Cancel a correspondent bank transfer transaction","isWebhook":false,"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a correspondent bank transfer 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":"Cancel the correspondent bank transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the correspondent bank transfer transaction.","required":true}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"schemaId":"components/schemas/TransactionSingleCancelRequest","pointer":"/paths/~1correspondent_bank_transfers~1{id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/correspondent_bank_transfers/{id}/cancel","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/correspondent_bank_transfers/{id}/cancel","href":"correspondent-bank-transfers/correspondentbanktransfercancel","openApiOperationId":"correspondentBankTransferCancel","summary":"Cancel a correspondent bank transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransactionSingleCancelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}},"schemaId":"components/schemas/CorrespondentBankingOwt","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorrespondentBankingOwt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondentbanktransfercancel"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers/{id}/cancel"},{"label":"Confirm a correspondent bank transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferconfirm","routeSlug":"/products/multi/openapi/correspondent-bank-transfers/correspondentbanktransferconfirm","metadata":{"seo":{"title":"Confirm a correspondent bank transfer transaction","description":"Confirm the correspondent bank transfer identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondentBankTransferConfirm","name":"Confirm a correspondent bank transfer transaction","isWebhook":false,"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1confirm/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm a correspondent bank transfer 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":"Confirm the correspondent bank transfer identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the correspondent bank transfer transaction.","required":true}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1confirm/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/correspondent_bank_transfers/{id}/confirm","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/correspondent_bank_transfers/{id}/confirm","href":"correspondent-bank-transfers/correspondentbanktransferconfirm","openApiOperationId":"correspondentBankTransferConfirm","summary":"Confirm a correspondent bank transfer transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}},"schemaId":"components/schemas/CorrespondentBankingOwt","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1correspondent_bank_transfers~1{id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CorrespondentBankingOwt","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CorrespondentBankingOwt"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondentbanktransferconfirm"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers/{id}/confirm"}],"content":{"contentType":"group","meta":{"name":"Correspondent Bank Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Correspondent Bank Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties).\nThese transfers comply with travel rule requirements by capturing and transmitting originator information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/correspondent_bank_transfers","summary":"Create a correspondent bank transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondent-bank-transfers/correspondentbanktransfercreate","deprecated":false},{"title":"/correspondent_bank_transfers","summary":"Get all correspondent bank transfer transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/correspondent-bank-transfers/correspondentbanktransfersget","deprecated":false},{"title":"/correspondent_bank_transfers/{id}","summary":"Get a correspondent bank transfer transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/correspondent-bank-transfers/correspondentbanktransferget","deprecated":false},{"title":"/correspondent_bank_transfers/{id}/cancel","summary":"Cancel a correspondent bank transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondent-bank-transfers/correspondentbanktransfercancel","deprecated":false},{"title":"/correspondent_bank_transfers/{id}/confirm","summary":"Confirm a correspondent bank transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondent-bank-transfers/correspondentbanktransferconfirm","deprecated":false}]}]}]}]}},{"type":"separator","label":"Card Payments","content":null},{"type":"group","label":"Card Payments","link":"/products/multi/openapi/card-payments","routeSlug":"/products/multi/openapi/card-payments","items":[{"label":"Get all card payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymentsget","routeSlug":"/products/multi/openapi/card-payments/cardpaymentsget","metadata":{"seo":{"title":"Get all card payments","description":"Returns the aggregated card payments for the logged-in identity. A CardPayment represents the full lifecycle of a card payment (authorisation + settlements + optional reversal/expiry/refund/original credit) as a single business-level entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPaymentsGet","name":"Get all card payments","isWebhook":false,"pointer":"/paths/~1card_payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all card payments","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 aggregated card payments for the logged-in identity. A CardPayment represents the full lifecycle of a card payment (authorisation + settlements + optional reversal/expiry/refund/original credit) as a single business-level entity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"cardId","in":"query","schemaId":"components/schemas/Id","description":"Filter by the managed card the payment belongs to."},{"name":"status","in":"query","schemaId":"schema_535","description":"Filter by one or more card payment statuses."},{"name":"type","in":"query","schemaId":"schema_536","description":"Filter by one or more card payment types."},{"name":"subtype","in":"query","schemaId":"schema_537","description":"Filter by one or more event subtypes (joined against the events timeline)."},{"name":"merchantName","in":"query","schemaId":"schema_359","description":"Partial, case-insensitive match against merchant name."},{"name":"amountFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount.amount >= amountFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"amountTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount.amount <= amountTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"relatedCardPaymentId","in":"query","schemaId":"components/schemas/Id","description":"Filter for card payments related to the given parent id."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","schemaId":"schema_465"},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTimestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". ASC = oldest first."},"children":[]}]}]}]}],"pointer":"/paths/~1card_payments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]}],"pointer":"/paths/~1card_payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/card_payments","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"cardId","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"status","in":"query","required":false,"schemaId":"schema_535","explode":false},{"name":"type","in":"query","required":false,"schemaId":"schema_536","explode":false},{"name":"subtype","in":"query","required":false,"schemaId":"schema_537","explode":false},{"name":"merchantName","in":"query","required":false,"schemaId":"schema_359"},{"name":"amountFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"amountTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"relatedCardPaymentId","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"lastUpdatedTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500","default"],"pointer":"/card_payments","href":"card-payments/cardpaymentsget","openApiOperationId":"cardPaymentsGet","summary":"Get all card payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPaymentList"}},"schemaId":"components/schemas/CardPaymentList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1card_payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardPaymentList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPaymentList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"500"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-payments/cardpaymentsget"}],"panels":[]}]},"httpPath":"/card_payments"},{"label":"Get a single card payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymentget","routeSlug":"/products/multi/openapi/card-payments/cardpaymentget","metadata":{"seo":{"title":"Get a single card payment","description":"Returns a single card payment by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPaymentGet","name":"Get a single card payment","isWebhook":false,"pointer":"/paths/~1card_payments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single card payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single card payment by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of a card payment.","required":true}],"pointer":"/paths/~1card_payments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/card_payments/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500","default"],"pointer":"/card_payments/{id}","href":"card-payments/cardpaymentget","openApiOperationId":"cardPaymentGet","summary":"Get a single card payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPayment"}},"schemaId":"components/schemas/CardPayment","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1card_payments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPayment"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-payments/cardpaymentget"}],"panels":[]}]},"httpPath":"/card_payments/{id}"},{"label":"Get all card payment events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/card-payments/cardpaymenteventsget","routeSlug":"/products/multi/openapi/card-payments/cardpaymenteventsget","metadata":{"seo":{"title":"Get all card payment events","description":"Returns a flat, chronological list of card payment events across one or more card payments. Each entry carries the event plus the parent CardPayment context (card, merchant, group)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cardPaymentEventsGet","name":"Get all card payment events","isWebhook":false,"pointer":"/paths/~1card_payment_events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all card payment events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a flat, chronological list of card payment events across one or more card payments. Each entry carries the event plus the parent CardPayment context (card, merchant, group)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"cardPaymentId","in":"query","schemaId":"components/schemas/Id","description":"Filter events to a single card payment."},{"name":"cardId","in":"query","schemaId":"components/schemas/Id","description":"Filter events to those on a single managed card."},{"name":"type","in":"query","schemaId":"schema_538","description":"Filter by one or more event types."},{"name":"subtype","in":"query","schemaId":"schema_537","description":"Filter events by one or more network subtypes."},{"name":"reversal","in":"query","schemaId":"schema_378","description":"Filter events by reversal flag."},{"name":"timestampFrom","in":"query","schemaId":"schema_465"},{"name":"timestampTo","in":"query","schemaId":"schema_465"},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order on event timestamp. ASC = oldest first (default DESC)."},"children":[]}]}]}]}],"pointer":"/paths/~1card_payment_events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"accept","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A request parameter specifying the type of response the client would like. Must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"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 default response type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") will be returned if specified incorrectly or not specified."},"children":[]}]}]}]}],"pointer":"/paths/~1card_payment_events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/card_payment_events","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"cardPaymentId","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"cardId","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"type","in":"query","required":false,"schemaId":"schema_538","explode":false},{"name":"subtype","in":"query","required":false,"schemaId":"schema_537","explode":false},{"name":"reversal","in":"query","required":false,"schemaId":"schema_378"},{"name":"timestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"timestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"}],"querystring":[],"header":[{"name":"accept","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500","default"],"pointer":"/card_payment_events","href":"card-payments/cardpaymenteventsget","openApiOperationId":"cardPaymentEventsGet","summary":"Get all card payment events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPaymentEventList"}},"schemaId":"components/schemas/CardPaymentEventList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1card_payment_events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardPaymentEventList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPaymentEventList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"500"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/card-payments/cardpaymenteventsget"}],"panels":[]}]},"httpPath":"/card_payment_events"}],"content":{"contentType":"group","meta":{"name":"Card Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card Payments","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve card payment activity, including authorisations, settlements, and related events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/card_payments","summary":"Get all card payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-payments/cardpaymentsget","deprecated":false},{"title":"/card_payments/{id}","summary":"Get a single card payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-payments/cardpaymentget","deprecated":false},{"title":"/card_payment_events","summary":"Get all card payment events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/card-payments/cardpaymenteventsget","deprecated":false}]}]}]}]}},{"type":"group","label":"Spend Controls","link":"/products/multi/openapi/spend-controls","routeSlug":"/products/multi/openapi/spend-controls","items":[{"label":"Get all spend rules for a managed card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesget","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesget","metadata":{"seo":{"title":"Get all spend rules for a managed card","description":"Fetch the list of spend rules associated with the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardSpendRulesGet","name":"Get all spend rules for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all spend rules for a managed 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":"Fetch the list of spend rules associated with the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/managed_cards/{id}/spend_rules","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}/spend_rules","href":"spend-controls/managedcardspendrulesget","openApiOperationId":"managedCardSpendRulesGet","summary":"Get all spend rules for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllLevelSpendRules"}},"schemaId":"components/schemas/AllLevelSpendRules","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AllLevelSpendRules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AllLevelSpendRules"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/managedcardspendrulesget"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Create spend rules for a managed card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulescreate","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulescreate","metadata":{"seo":{"title":"Create spend rules for a managed card","description":"Create the spend rules associated with the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardSpendRulesCreate","name":"Create spend rules for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create spend rules for a managed 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":"Create the spend rules associated with the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardLevelSpendRules"}},"schemaId":"components/schemas/CardLevelSpendRules","pointer":"/paths/~1managed_cards~1{id}~1spend_rules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/managed_cards/{id}/spend_rules","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardLevelSpendRules"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/spend_rules","href":"spend-controls/managedcardspendrulescreate","openApiOperationId":"managedCardSpendRulesCreate","summary":"Create spend rules for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CardLevelSpendRules","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardLevelSpendRules"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/managedcardspendrulescreate"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Update spend rules for a managed card","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesupdate","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesupdate","metadata":{"seo":{"title":"Update spend rules for a managed card","description":"Must be user after a POST, to update individual spend rules associated with the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardSpendRulesUpdate","name":"Update spend rules for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update spend rules for a managed 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":"Must be user after a POST, to update individual spend rules associated with the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCardLevelSpendRules"}},"schemaId":"components/schemas/UpdateCardLevelSpendRules","pointer":"/paths/~1managed_cards~1{id}~1spend_rules/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/managed_cards/{id}/spend_rules","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCardLevelSpendRules"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/managed_cards/{id}/spend_rules","href":"spend-controls/managedcardspendrulesupdate","openApiOperationId":"managedCardSpendRulesUpdate","summary":"Update spend rules for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateCardLevelSpendRules","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCardLevelSpendRules"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}},"schemaId":"schema_540"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_540","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/managedcardspendrulesupdate"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/spend_rules"},{"label":"Delete all spend rules for a managed card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/spend-controls/managedcardspendrulesdelete","routeSlug":"/products/multi/openapi/spend-controls/managedcardspendrulesdelete","metadata":{"seo":{"title":"Delete all spend rules for a managed card","description":"Remove all spend rules associated with the managed card identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managedCardSpendRulesDelete","name":"Delete all spend rules for a managed card","isWebhook":false,"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all spend rules for a managed 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":"Remove all spend rules associated with the managed card identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","required":true}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/managed_cards/{id}/spend_rules","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id","style":"simple"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","429","500","503","default"],"pointer":"/managed_cards/{id}/spend_rules","href":"spend-controls/managedcardspendrulesdelete","openApiOperationId":"managedCardSpendRulesDelete","summary":"Delete all spend rules for a managed card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1{id}~1spend_rules/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/managedcardspendrulesdelete"}],"panels":[]}]},"httpPath":"/managed_cards/{id}/spend_rules"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Approve or reject card payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/multi/openapi/spend-controls/managed_cards_authorisation_forwarding","routeSlug":"/products/multi/openapi/spend-controls/managed_cards_authorisation_forwarding","metadata":{"seo":{"title":"Approve or reject card payments","description":"Receive purchase authorisation events and choose if to approve or decline them by replying to the event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_authorisation_forwarding","name":"Approve or reject card payments","isWebhook":true,"pointer":"/paths/~1managed_cards~1authorisation_request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve or reject card payments","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":"Receive purchase authorisation events and choose if to approve or decline them by replying to the event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Switch on Authorisation Forwarding in your Sandbox Innovator Portal and configure the Authorisation Forwarding URL to start receiving these events. Weavr will send webhook events on the following URL {Authorisation Forwarding URL}/managed_cards_authorisation_forwarding."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A response is expected in 1.5s, after which the Default Timeout Response configured in the card profile or the card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authForwardingDefaultTimeoutDecision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter will be used."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"webhooks_key","scopes":[],"type":"apiKey","in":"header","paramName":"webhooks-key","description":"The Webhooks key can be found in the API Credentials tab in your Portal Page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_359","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_465","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_359","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1authorisation_request/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardAuthorisationEvent"}},"schemaId":"components/schemas/CardAuthorisationEvent","pointer":"/paths/~1managed_cards~1authorisation_request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/authorisation_request","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_359"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_465","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_359","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_359","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"webhooks_key","type":"apiKey","name":"webhooks-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardAuthorisationEvent"}},"responseCodes":["200","404","default"],"pointer":"/managed_cards/authorisation_request","href":"spend-controls/managed_cards_authorisation_forwarding","openApiOperationId":"managed_cards_authorisation_forwarding","summary":"Approve or reject card payments"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CardAuthorisationEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardAuthorisationEvent"}},"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":"Authorisation event received with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decision."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1managed_cards~1authorisation_request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spend-controls/managed_cards_authorisation_forwarding"}],"panels":[]}]},"httpPath":"/managed_cards/authorisation_request"}],"content":{"contentType":"group","meta":{"name":"Spend Controls"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spend Controls","showPageActions":true},{"nodeType":"markdoc","content":"Manage spend rules and authorisation forwarding to approve or reject card payments in real time."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/managed_cards/{id}/spend_rules","summary":"Get all spend rules for a managed card","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spend-controls/managedcardspendrulesget","deprecated":false},{"title":"/managed_cards/{id}/spend_rules","summary":"Create spend rules for a managed card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend-controls/managedcardspendrulescreate","deprecated":false},{"title":"/managed_cards/{id}/spend_rules","summary":"Update spend rules for a managed card","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/spend-controls/managedcardspendrulesupdate","deprecated":false},{"title":"/managed_cards/{id}/spend_rules","summary":"Delete all spend rules for a managed card","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/spend-controls/managedcardspendrulesdelete","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/managed_cards/authorisation_request","summary":"Approve or reject card payments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/spend-controls/managed_cards_authorisation_forwarding","deprecated":false}]}]}]}]}},{"type":"separator","label":"In-Platform Payments","content":null},{"type":"group","label":"Sends","link":"/products/multi/openapi/sends","routeSlug":"/products/multi/openapi/sends","items":[{"label":"Create a send transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendcreate","routeSlug":"/products/multi/openapi/sends/sendcreate","metadata":{"seo":{"title":"Create a send transaction","description":"Sends funds between managed accounts and managed cards belonging to different corporate or consumer identities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendCreate","name":"Create a send transaction","isWebhook":false,"pointer":"/paths/~1sends/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a send 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":"Sends funds between managed accounts and managed cards belonging to "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corporate or consumer identities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Send Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1sends/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendCreateRequest"}},"schemaId":"components/schemas/SendCreateRequest","pointer":"/paths/~1sends/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sends","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SendCreateRequest"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/sends","href":"sends/sendcreate","openApiOperationId":"sendCreate","summary":"Create a send transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SendCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}},"schemaId":"components/schemas/Send","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}},"schemaId":"schema_541"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Send","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_541","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendcreate"}],"panels":[]}]},"httpPath":"/sends"},{"label":"Get all send transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendsget","routeSlug":"/products/multi/openapi/sends/sendsget","metadata":{"seo":{"title":"Get all send transactions","description":"Retrieves all the send transactions performed by the logged-in identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendsGet","name":"Get all send transactions","isWebhook":false,"pointer":"/paths/~1sends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all send transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all the send transactions performed by the logged-in identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"profileId","in":"query","schemaId":"schema_459","description":"Filter by the Send profile. Leave out to fetch all entries."},{"name":"instrumentId","in":"query","schemaId":"schema_515","description":"Filter by the source instrument id."},{"name":"source.id","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument id. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"source.type","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the source instrument type. Must be specified when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_543","description":"Filter by the Send transaction state. Leave out to fetch all states."},{"name":"createdFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for send transactions created after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for send transactions created before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions."},"children":[]}]}]}]},{"name":"executedFrom","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for send transactions executed after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions."},"children":[]}]}]}]},{"name":"executedTo","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter for send transactions executed before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executedTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions."},"children":[]}]}]}]},{"name":"tag","in":"query","schemaId":"schema_359","description":"Filter by the send tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries."}],"pointer":"/paths/~1sends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sends","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"profileId","in":"query","required":false,"schemaId":"components/schemas/ProfileId"},{"name":"instrumentId","in":"query","required":false,"schemaId":"components/schemas/InstrumentId"},{"name":"source.id","in":"query","required":false,"schemaId":"components/schemas/Id"},{"name":"source.type","in":"query","required":false,"schemaId":"components/schemas/InstrumentType"},{"name":"state","in":"query","required":false,"schemaId":"schema_543"},{"name":"createdFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"createdTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"executedTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"tag","in":"query","required":false,"schemaId":"schema_359"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/sends","href":"sends/sendsget","openApiOperationId":"sendsGet","summary":"Get all send transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_544"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendsget"}],"panels":[]}]},"httpPath":"/sends"},{"label":"Get a send transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendget","routeSlug":"/products/multi/openapi/sends/sendget","metadata":{"seo":{"title":"Get a send transaction","description":"Retrieve the send transaction identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendGet","name":"Get a send transaction","isWebhook":false,"pointer":"/paths/~1sends~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a send 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 the send transaction identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Send transaction.","required":true}],"pointer":"/paths/~1sends~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sends/{id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/sends/{id}","href":"sends/sendget","openApiOperationId":"sendGet","summary":"Get a send transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}},"schemaId":"components/schemas/Send","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Send","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendget"}],"panels":[]}]},"httpPath":"/sends/{id}"},{"label":"Cancel a send transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendsinglecancel","routeSlug":"/products/multi/openapi/sends/sendsinglecancel","metadata":{"seo":{"title":"Cancel a send transaction","description":"Cancel the send transaction identified by the id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSingleCancel","name":"Cancel a send transaction","isWebhook":false,"pointer":"/paths/~1sends~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a send 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":"Cancel the send transaction identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the Send transaction.","required":true}],"pointer":"/paths/~1sends~1{id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"schemaId":"components/schemas/TransactionSingleCancelRequest","pointer":"/paths/~1sends~1{id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sends/{id}/cancel","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/sends/{id}/cancel","href":"sends/sendsinglecancel","openApiOperationId":"sendSingleCancel","summary":"Cancel a send transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransactionSingleCancelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransactionSingleCancelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}},"schemaId":"components/schemas/Send","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"}],"pointer":"/paths/~1sends~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Send","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Send"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"429"},{"code":"500"},{"code":"503"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendsinglecancel"}],"panels":[]}]},"httpPath":"/sends/{id}/cancel"},{"label":"Issue a one-time password that can be used to verify a send","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscachallenge","routeSlug":"/products/multi/openapi/sends/sendscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to verify a send","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSCAChallenge","name":"Issue a one-time password that can be used to verify a send","deprecated":true,"isWebhook":false,"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a one-time password that can be used to verify a send","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAChallenge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the verification process for a send in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/otp/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the send "},"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":"PENDING_CHALLENGE"},"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":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the send transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sends/{id}/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/sends/{id}/challenges/otp/{channel}","href":"sends/sendscachallenge","openApiOperationId":"sendSCAChallenge","summary":"Issue a one-time password that can be used to verify a send"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendscachallenge"}],"panels":[]}]},"httpPath":"/sends/{id}/challenges/otp/{channel}"},{"label":"Verify a send using a one-time password","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscaverify","routeSlug":"/products/multi/openapi/sends/sendscaverify","metadata":{"seo":{"title":"Verify a send using a one-time password","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSCAVerify","name":"Verify a send using a one-time password","deprecated":true,"isWebhook":false,"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a send using a one-time password","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAVerify"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completes the verification process for a Send."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the outcome of the verification is successful, the send is executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not verified challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud."},"children":[]}]}]},{"$$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":"Note that on the Sandbox Environment, text messages are not sent and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verificationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always \"123456\"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the send transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_404","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sends/{id}/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_406"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/sends/{id}/challenges/otp/{channel}/verify","href":"sends/sendscaverify","openApiOperationId":"sendSCAVerify","summary":"Verify a send using a one-time password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_406"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}},"schemaId":"schema_546"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends~1{id}~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendscaverify"}],"panels":[]}]},"httpPath":"/sends/{id}/challenges/otp/{channel}/verify"},{"label":"Issue a push notification that can be used to verify Send transaction","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/sends/sendscachallengepush","routeSlug":"/products/multi/openapi/sends/sendscachallengepush","metadata":{"seo":{"title":"Issue a push notification that can be used to verify Send transaction","description":"Deprecated in favour of Challenges endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendSCAChallengePush","name":"Issue a push notification that can be used to verify Send transaction","deprecated":true,"isWebhook":false,"pointer":"/paths/~1sends~1{id}~1challenges~1push~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a push notification that can be used to verify Send transaction","isWebhook":false,"deprecated":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":"Deprecated in favour of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Confirmation-Challenges/operation/multipleSCAChallengePush"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenges endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the verification process for a Send in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authentication_factors/push/{channel}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You should only start this process if the Send transaction "},"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":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"components/schemas/Id","description":"The unique identifier of the send transaction.","required":true},{"name":"channel","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1sends~1{id}~1challenges~1push~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sends/{id}/challenges/push/{channel}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"components/schemas/Id"},{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAPushChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","405","409","429","500","503","default"],"pointer":"/sends/{id}/challenges/push/{channel}","href":"sends/sendscachallengepush","openApiOperationId":"sendSCAChallengePush","summary":"Issue a push notification that can be used to verify Send transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"405","description":"Method Not Allowed - The request was received but has been rejected for the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sends~1{id}~1challenges~1push~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"405","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/sendscachallengepush"}],"panels":[]}]},"httpPath":"/sends/{id}/challenges/push/{channel}"}],"content":{"contentType":"group","meta":{"name":"Sends"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends","showPageActions":true},{"nodeType":"markdoc","content":"The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sends","summary":"Create a send transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sends/sendcreate","deprecated":false},{"title":"/sends","summary":"Get all send transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sends/sendsget","deprecated":false},{"title":"/sends/{id}","summary":"Get a send transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sends/sendget","deprecated":false},{"title":"/sends/{id}/cancel","summary":"Cancel a send transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sends/sendsinglecancel","deprecated":false},{"title":"/sends/{id}/challenges/otp/{channel}","summary":"Issue a one-time password that can be used to verify a send","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/sends/sendscachallenge","deprecated":true},{"title":"/sends/{id}/challenges/otp/{channel}/verify","summary":"Verify a send using a one-time password","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/sends/sendscaverify","deprecated":true},{"title":"/sends/{id}/challenges/push/{channel}","summary":"Issue a push notification that can be used to verify Send transaction","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/sends/sendscachallengepush","deprecated":true}]}]}]}]}},{"type":"group","label":"Fees","link":"/products/multi/openapi/fees","routeSlug":"/products/multi/openapi/fees","items":[{"label":"Charge fee to a corporate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/corporatechargefee","routeSlug":"/products/multi/openapi/fees/corporatechargefee","metadata":{"seo":{"title":"Charge fee to a corporate","description":"Charge a fee to the corporate identified by the auth token, based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporateChargeFee","name":"Charge fee to a corporate","isWebhook":false,"pointer":"/paths/~1corporates~1fees~1charge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge fee to a corporate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Charge a fee to the corporate identified by the auth token, based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal.\n\nThe fees collected will be deposited into your Revenue Account. The balance and transaction history of your revenue account can be viewed in the Multi Portal.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1corporates~1fees~1charge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","pointer":"/paths/~1corporates~1fees~1charge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/corporates/fees/charge","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/corporates/fees/charge","href":"fees/corporatechargefee","openApiOperationId":"corporateChargeFee","summary":"Charge fee to a corporate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeFee"}},"schemaId":"components/schemas/ChargeFee","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}},"schemaId":"schema_547"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1corporates~1fees~1charge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChargeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeFee"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"schema_547","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/corporatechargefee"}],"panels":[]}]},"httpPath":"/corporates/fees/charge"},{"label":"(NEW) Get all fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/feesget","routeSlug":"/products/multi/openapi/fees/feesget","metadata":{"seo":{"title":"(NEW) Get all fees","description":"Returns the fee transactions accrued by the logged-in identity — every FeeTransaction posted against any of the identity's instruments, filterable by time window."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"feesGet","name":"(NEW) Get all fees","isWebhook":false,"pointer":"/paths/~1fees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"(NEW) Get all fees","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 fee transactions accrued by the logged-in identity — every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posted against any of the identity's instruments, filterable by time window."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For surfaces that need fees inline with their parent activity, the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records are also exposed via the Transaction Activity API and on Statements V2."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"creationTimestampFrom","in":"query","schemaId":"schema_465","description":"Filter for transactions created after this timestamp. Epoch timestamp using millisecond precision."},{"name":"creationTimestampTo","in":"query","schemaId":"schema_465","description":"Filter for transactions created before this timestamp. Epoch timestamp using millisecond precision."},{"name":"sortOrder","in":"query","schemaId":"components/schemas/InstrumentStatementSortOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order for the results:"},"children":[]}]}]},{"$$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":"ASC: Ascending order, oldest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: Descending order, most recent first."},"children":[]}]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"creationTimestampFrom","in":"query","required":false,"schemaId":"schema_465"},{"name":"creationTimestampTo","in":"query","required":false,"schemaId":"schema_465"},{"name":"sortOrder","in":"query","required":false,"schemaId":"components/schemas/InstrumentStatementSortOrder"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/fees","href":"fees/feesget","openApiOperationId":"feesGet","summary":"(NEW) Get all fees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FeeTransactionList"}},"schemaId":"components/schemas/FeeTransactionList","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FeeTransactionList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FeeTransactionList"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/feesget"}],"panels":[]}]},"httpPath":"/fees"},{"label":"Charge fee to a consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/fees/consumerchargefee","routeSlug":"/products/multi/openapi/fees/consumerchargefee","metadata":{"seo":{"title":"Charge fee to a consumer","description":"Charge a fee to the logged-in consumer based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumerChargeFee","name":"Charge fee to a consumer","isWebhook":false,"pointer":"/paths/~1consumers~1fees~1charge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charge fee to a consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Charge a fee to the logged-in consumer based on a pre-defined custom fee. Custom fees can be configured in the Multi Portal.\n\nThe fees collected will be deposited into your Revenue Account. The balance and transaction history of your revenue account can be viewed in the Multi Portal.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1consumers~1fees~1charge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","pointer":"/paths/~1consumers~1fees~1charge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/consumers/fees/charge","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/consumers/fees/charge","href":"fees/consumerchargefee","openApiOperationId":"consumerChargeFee","summary":"Charge fee to a consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeFee"}},"schemaId":"components/schemas/ChargeFee","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}},"schemaId":"schema_547"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"},"x-ratelimit-limit":{"$ref":"#/components/headers/x-ratelimit-limit"},"x-ratelimit-reset":{"$ref":"#/components/headers/x-ratelimit-reset"}},"headerSchemaId":"schema_365"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1consumers~1fees~1charge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChargeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargeFee"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"409","schemaId":"schema_547","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/consumerchargefee"}],"panels":[]}]},"httpPath":"/consumers/fees/charge"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":"Charge and retrieve in-platform fees."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/corporates/fees/charge","summary":"Charge fee to a corporate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/corporatechargefee","deprecated":false},{"title":"/fees","summary":"(NEW) Get all fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/feesget","deprecated":false},{"title":"/consumers/fees/charge","summary":"Charge fee to a consumer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/consumerchargefee","deprecated":false}]}]}]}]}},{"type":"separator","label":"Bulk Operations","content":null},{"type":"group","label":"Operations","link":"/products/multi/openapi/operations","routeSlug":"/products/multi/openapi/operations","items":[{"label":"Create users in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksusercreate","routeSlug":"/products/multi/openapi/operations/bulksusercreate","metadata":{"seo":{"title":"Create users in bulk","description":"Submit the details for the creation of a batch of Authorised Users"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksUserCreate","name":"Create users in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create users in bulk","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 the details for the creation of a batch of Authorised Users"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Setup/operation/userCreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_548"}},"schemaId":"schema_548","pointer":"/paths/~1bulks~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/users","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_548"}},"responseCodes":["201"],"pointer":"/bulks/users","href":"operations/bulksusercreate","openApiOperationId":"bulksUserCreate","summary":"Create users in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_548","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_548"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksusercreate"}],"panels":[]}]},"httpPath":"/bulks/users"},{"label":"Send user invites in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksuserinvitesend","routeSlug":"/products/multi/openapi/operations/bulksuserinvitesend","metadata":{"seo":{"title":"Send user invites in bulk","description":"Submit the details for the creation of a batch of Authorised User invites"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksUserInviteSend","name":"Send user invites in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1users~1_user_id_~1invite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send user invites in bulk","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 the details for the creation of a batch of Authorised User invites"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Setup/operation/userInviteSend"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a User Invite"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1users~1_user_id_~1invite/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550","pointer":"/paths/~1bulks~1users~1_user_id_~1invite/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/users/_user_id_/invite","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_550"}},"responseCodes":["201"],"pointer":"/bulks/users/_user_id_/invite","href":"operations/bulksuserinvitesend","openApiOperationId":"bulksUserInviteSend","summary":"Send user invites in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_550"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1users~1_user_id_~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksuserinvitesend"}],"panels":[]}]},"httpPath":"/bulks/users/_user_id_/invite"},{"label":"Block cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardblock","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardblock","metadata":{"seo":{"title":"Block cards in bulk","description":"Submit the details to block Managed Cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksManagedCardBlock","name":"Block cards in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1managed_cards~1_id_~1block/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Block cards in bulk","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 the details to block Managed Cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Managed-Cards/operation/managedCardBlock"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block a Managed Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1block/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551","pointer":"/paths/~1bulks~1managed_cards~1_id_~1block/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/managed_cards/_id_/block","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_551"}},"responseCodes":["201"],"pointer":"/bulks/managed_cards/_id_/block","href":"operations/bulksmanagedcardblock","openApiOperationId":"bulksManagedCardBlock","summary":"Block cards in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1block/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksmanagedcardblock"}],"panels":[]}]},"httpPath":"/bulks/managed_cards/_id_/block"},{"label":"Unblock cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardunblock","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardunblock","metadata":{"seo":{"title":"Unblock cards in bulk","description":"Submit the details to unblock Managed Cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksManagedCardUnblock","name":"Unblock cards in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1managed_cards~1_id_~1unblock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unblock cards in bulk","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 the details to unblock Managed Cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Managed-Cards/operation/managedCardUnblock"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unblock a Managed Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1unblock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551","pointer":"/paths/~1bulks~1managed_cards~1_id_~1unblock/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/managed_cards/_id_/unblock","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_551"}},"responseCodes":["201"],"pointer":"/bulks/managed_cards/_id_/unblock","href":"operations/bulksmanagedcardunblock","openApiOperationId":"bulksManagedCardUnblock","summary":"Unblock cards in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1unblock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksmanagedcardunblock"}],"panels":[]}]},"httpPath":"/bulks/managed_cards/_id_/unblock"},{"label":"Remove cards in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardremove","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardremove","metadata":{"seo":{"title":"Remove cards in bulk","description":"Submit the details to remove Managed Cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksManagedCardRemove","name":"Remove cards in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1managed_cards~1_id_~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove cards in bulk","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 the details to remove Managed Cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Managed-Cards/operation/managedCardRemove"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a Managed Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551","pointer":"/paths/~1bulks~1managed_cards~1_id_~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/managed_cards/_id_/remove","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_551"}},"responseCodes":["201"],"pointer":"/bulks/managed_cards/_id_/remove","href":"operations/bulksmanagedcardremove","openApiOperationId":"bulksManagedCardRemove","summary":"Remove cards in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksmanagedcardremove"}],"panels":[]}]},"httpPath":"/bulks/managed_cards/_id_/remove"},{"label":"Update spend rules for a managed card in bulk","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksmanagedcardspendrulesupdate","routeSlug":"/products/multi/openapi/operations/bulksmanagedcardspendrulesupdate","metadata":{"seo":{"title":"Update spend rules for a managed card in bulk","description":"Submit the details to update the spend rules of Managed Cards"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksManagedCardSpendRulesUpdate","name":"Update spend rules for a managed card in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1managed_cards~1_id_~1spend_rules/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update spend rules for a managed card in bulk","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 the details to update the spend rules of Managed Cards"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Spend-Controls/operation/managedCardSpendRulesUpdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Spend Rules for a Managed Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1spend_rules/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_552"}},"schemaId":"schema_552","pointer":"/paths/~1bulks~1managed_cards~1_id_~1spend_rules/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/bulks/managed_cards/_id_/spend_rules","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_552"}},"responseCodes":["201"],"pointer":"/bulks/managed_cards/_id_/spend_rules","href":"operations/bulksmanagedcardspendrulesupdate","openApiOperationId":"bulksManagedCardSpendRulesUpdate","summary":"Update spend rules for a managed card in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_552","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_552"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1managed_cards~1_id_~1spend_rules/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksmanagedcardspendrulesupdate"}],"panels":[]}]},"httpPath":"/bulks/managed_cards/_id_/spend_rules"},{"label":"Create transfer transactions in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulkstransfercreate","routeSlug":"/products/multi/openapi/operations/bulkstransfercreate","metadata":{"seo":{"title":"Create transfer transactions in bulk","description":"Submit the details for the creation of a batch of Transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksTransferCreate","name":"Create transfer transactions in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create transfer transactions in bulk","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 the details for the creation of a batch of Transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Transfers/operation/transferCreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Transfer Transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553","pointer":"/paths/~1bulks~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_553"}},"responseCodes":["201"],"pointer":"/bulks/transfers","href":"operations/bulkstransfercreate","openApiOperationId":"bulksTransferCreate","summary":"Create transfer transactions in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_553"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulkstransfercreate"}],"panels":[]}]},"httpPath":"/bulks/transfers"},{"label":"Create send transactions in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulkssendcreate","routeSlug":"/products/multi/openapi/operations/bulkssendcreate","metadata":{"seo":{"title":"Create send transactions in bulk","description":"Submit the details for the creation of a batch of Sends."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksSendCreate","name":"Create send transactions in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1sends/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create send transactions in bulk","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 the details for the creation of a batch of Sends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Sends/operation/sendCreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Send Transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1sends/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554","pointer":"/paths/~1bulks~1sends/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/sends","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_554"}},"responseCodes":["201"],"pointer":"/bulks/sends","href":"operations/bulkssendcreate","openApiOperationId":"bulksSendCreate","summary":"Create send transactions in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1sends/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulkssendcreate"}],"panels":[]}]},"httpPath":"/bulks/sends"},{"label":"Create an outgoing wire transfer in bulk","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/operations/bulksoutgoingwiretransfercreate","routeSlug":"/products/multi/openapi/operations/bulksoutgoingwiretransfercreate","metadata":{"seo":{"title":"Create an outgoing wire transfer in bulk","description":"Submit the details for the creation of a batch of Outgoing Wire Transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulksOutgoingWireTransferCreate","name":"Create an outgoing wire transfer in bulk","isWebhook":false,"pointer":"/paths/~1bulks~1outgoing_wire_transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an outgoing wire transfer in bulk","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 the details for the creation of a batch of Outgoing Wire Transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bulkId returned in the response can subsequently be used to launch the execution of the bulk process through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdExecute"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute Bulk Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any Authorised User of the same identity of the user that submits the details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submission of data for a bulk process does not expire but it can be cancelled through "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Manage/operation/bulkIdCancel"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Bulk Process"},"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 system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each individual operation in this bulk will be processed via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Outgoing-Wire-Transfers/operation/outgoingWireTransferCreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an Outgoing Wire Transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_359","description":"A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours."}],"pointer":"/paths/~1bulks~1outgoing_wire_transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"schemaId":"schema_555","pointer":"/paths/~1bulks~1outgoing_wire_transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/outgoing_wire_transfers","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_359"}],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_555"}},"responseCodes":["201"],"pointer":"/bulks/outgoing_wire_transfers","href":"operations/bulksoutgoingwiretransfercreate","openApiOperationId":"bulksOutgoingWireTransferCreate","summary":"Create an outgoing wire transfer in bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_555","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success - returning bulk process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"}],"pointer":"/paths/~1bulks~1outgoing_wire_transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operations/bulksoutgoingwiretransfercreate"}],"panels":[]}]},"httpPath":"/bulks/outgoing_wire_transfers"}],"content":{"contentType":"group","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bulks/users","summary":"Create users in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksusercreate","deprecated":false},{"title":"/bulks/users/_user_id_/invite","summary":"Send user invites in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksuserinvitesend","deprecated":false},{"title":"/bulks/managed_cards/_id_/block","summary":"Block cards in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksmanagedcardblock","deprecated":false},{"title":"/bulks/managed_cards/_id_/unblock","summary":"Unblock cards in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksmanagedcardunblock","deprecated":false},{"title":"/bulks/managed_cards/_id_/remove","summary":"Remove cards in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksmanagedcardremove","deprecated":false},{"title":"/bulks/managed_cards/_id_/spend_rules","summary":"Update spend rules for a managed card in bulk","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/operations/bulksmanagedcardspendrulesupdate","deprecated":false},{"title":"/bulks/transfers","summary":"Create transfer transactions in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulkstransfercreate","deprecated":false},{"title":"/bulks/sends","summary":"Create send transactions in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulkssendcreate","deprecated":false},{"title":"/bulks/outgoing_wire_transfers","summary":"Create an outgoing wire transfer in bulk","prefix":{"name":"post","color":"post"},"badges":[],"link":"/operations/bulksoutgoingwiretransfercreate","deprecated":false}]}]}]}]}},{"type":"group","label":"Manage","link":"/products/multi/openapi/manage","routeSlug":"/products/multi/openapi/manage","items":[{"label":"Get all bulk processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulks","routeSlug":"/products/multi/openapi/manage/bulks","metadata":{"seo":{"title":"Get all bulk processes","description":"Filter bulk processes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulks","name":"Get all bulk processes","isWebhook":false,"pointer":"/paths/~1bulks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all bulk processes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filter bulk processes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"status","in":"query","schemaId":"schema_556"}],"pointer":"/paths/~1bulks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulks","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/BulkProcessStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500","503","default"],"pointer":"/bulks","href":"manage/bulks","openApiOperationId":"bulks","summary":"Get all bulk processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessesPaged"}},"schemaId":"components/schemas/BulkProcessesPaged"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"BulkProcessorConflict - bulk processor conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}},"schemaId":"components/schemas/BulkProcessConflict","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkProcessesPaged","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessesPaged"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/BulkProcessConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulks"}],"panels":[]}]},"httpPath":"/bulks"},{"label":"Get bulk process","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkid","routeSlug":"/products/multi/openapi/manage/bulkid","metadata":{"seo":{"title":"Get bulk process","description":"Retrieves details on the bulk process identified by the bulk_id parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkId","name":"Get bulk process","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bulk process","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 details on the bulk process identified by the bulk_id parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulks/{bulk_id}","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503","default"],"pointer":"/bulks/{bulk_id}","href":"manage/bulkid","openApiOperationId":"bulkId","summary":"Get bulk process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessDetails"}},"schemaId":"components/schemas/BulkProcessDetails","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkProcessDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessDetails"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkid"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}"},{"label":"Get all operations in a bulk","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidoperations","routeSlug":"/products/multi/openapi/manage/bulkidoperations","metadata":{"seo":{"title":"Get all operations in a bulk","description":"Retrieves the bulk process operations that match the query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkIdOperations","name":"Get all operations in a bulk","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}~1operations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all operations in a bulk","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the bulk process operations that match the query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}~1operations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_376","description":"The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results."},{"name":"limit","in":"query","schemaId":"schema_377","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"sequence","in":"query","schemaId":"schema_465"},{"name":"status","in":"query","schemaId":"schema_558"}],"pointer":"/paths/~1bulks~1{bulk_id}~1operations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bulks/{bulk_id}/operations","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_376"},{"name":"limit","in":"query","required":false,"schemaId":"schema_377"},{"name":"sequence","in":"query","required":false,"schemaId":"schema_465"},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/BulkProcessOperationStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503","default"],"pointer":"/bulks/{bulk_id}/operations","href":"manage/bulkidoperations","openApiOperationId":"bulkIdOperations","summary":"Get all operations in a bulk"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessOperationsPaged"}},"schemaId":"components/schemas/BulkProcessOperationsPaged","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}~1operations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkProcessOperationsPaged","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessOperationsPaged"}}},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkidoperations"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}/operations"},{"label":"Execute bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidexecute","routeSlug":"/products/multi/openapi/manage/bulkidexecute","metadata":{"seo":{"title":"Execute bulk process","description":"Launches execution of operations of any bulk process identified by the bulk_id  parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkIdExecute","name":"Execute bulk process","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}~1execute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute bulk process","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":"Launches execution of operations of any bulk process identified by the bulk_id  parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process has to be in a ‘SUBMITTED’ state and after execution initiates, the bulk process state is set to ‘RUNNING’."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final state of execution can be any of"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED:  none of the operations of the bulk process have executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIALLY_COMPLETED: the execution of the bulk process is complete and some of the bulk operations of the bulk process failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is asynchronous and will return immediately. You can track the status of the execution of the bulk process through Get bulk process. You can also pause execution through "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bulkIdPause"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}~1execute/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkProcessExecute"}},"schemaId":"components/schemas/BulkProcessExecute","pointer":"/paths/~1bulks~1{bulk_id}~1execute/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/{bulk_id}/execute","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkProcessExecute"}},"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/bulks/{bulk_id}/execute","href":"manage/bulkidexecute","openApiOperationId":"bulkIdExecute","summary":"Execute bulk process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BulkProcessExecute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkProcessExecute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"BulkProcessorConflict - bulk processor conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}},"schemaId":"components/schemas/BulkProcessConflict","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}~1execute/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/BulkProcessConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkidexecute"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}/execute"},{"label":"Pause bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidpause","routeSlug":"/products/multi/openapi/manage/bulkidpause","metadata":{"seo":{"title":"Pause bulk process","description":"Pauses the execution of operations of the bulk process that is in state ‘RUNNING’ as identified by the bulk_id  parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkIdPause","name":"Pause bulk process","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}~1pause/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pause bulk process","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":"Pauses the execution of operations of the bulk process that is in state ‘RUNNING’ as identified by the bulk_id  parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set to ‘PAUSED’"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The execution can be resumed through "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bulkIdResume"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}~1pause/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/{bulk_id}/pause","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/bulks/{bulk_id}/pause","href":"manage/bulkidpause","openApiOperationId":"bulkIdPause","summary":"Pause bulk process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"BulkProcessorConflict - bulk processor conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}},"schemaId":"components/schemas/BulkProcessConflict","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}~1pause/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/BulkProcessConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkidpause"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}/pause"},{"label":"Resume bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidresume","routeSlug":"/products/multi/openapi/manage/bulkidresume","metadata":{"seo":{"title":"Resume bulk process","description":"Resumes the execution of operations of the bulk process that is in state ' PAUSED' as identified by the bulk_id parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkIdResume","name":"Resume bulk process","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}~1resume/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resume bulk process","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":"Resumes the execution of operations of the bulk process that is in state ' PAUSED' as identified by the bulk_id parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set back to ‘RUNNING’"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}~1resume/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/{bulk_id}/resume","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/bulks/{bulk_id}/resume","href":"manage/bulkidresume","openApiOperationId":"bulkIdResume","summary":"Resume bulk process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"BulkProcessorConflict - bulk processor conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}},"schemaId":"components/schemas/BulkProcessConflict","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/BulkProcessConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkidresume"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}/resume"},{"label":"Cancel bulk process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/multi/openapi/manage/bulkidcancel","routeSlug":"/products/multi/openapi/manage/bulkidcancel","metadata":{"seo":{"title":"Cancel bulk process","description":"Cancels the execution of operations of a bulk process that is in state ‘PAUSED’ or ‘RUNNING’ as identified by the bulk_id parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkIdCancel","name":"Cancel bulk process","isWebhook":false,"pointer":"/paths/~1bulks~1{bulk_id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel bulk process","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":"Cancels the execution of operations of a bulk process that is in state ‘PAUSED’ or ‘RUNNING’ as identified by the bulk_id parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the bulk process after execution of this operation is set  to ‘CANCELLED’. This is a final state and a cancelled bulk process cannot be resumed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"auth_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},{"name":"api-key","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"bulk_id","in":"path","schemaId":"schema_557","description":"The bulk id of the bulk process.","required":true}],"pointer":"/paths/~1bulks~1{bulk_id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bulks/{bulk_id}/cancel","servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"bulk_id","in":"path","required":true,"schemaId":"components/schemas/Id"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"api-key","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/bulks/{bulk_id}/cancel","href":"manage/bulkidcancel","openApiOperationId":"bulkIdCancel","summary":"Cancel bulk process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success - No Content.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"409","description":"BulkProcessorConflict - bulk processor conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}},"schemaId":"components/schemas/BulkProcessConflict","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"503","description":"Service Unavailable - The requested service is temporarily unavailable. Please try again later.","headers":{"request-ref":{"$ref":"#/components/headers/request-ref"}},"headerSchemaId":"schema_361"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1bulks~1{bulk_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"401"},{"code":"403","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/BulkProcessConflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkProcessConflict"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage/bulkidcancel"}],"panels":[]}]},"httpPath":"/bulks/{bulk_id}/cancel"}],"content":{"contentType":"group","meta":{"name":"Manage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage","showPageActions":true},{"nodeType":"markdoc","content":"Manage bulk processes that group together multiple operations to be executed asynchronously."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bulks","summary":"Get all bulk processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage/bulks","deprecated":false},{"title":"/bulks/{bulk_id}","summary":"Get bulk process","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage/bulkid","deprecated":false},{"title":"/bulks/{bulk_id}/operations","summary":"Get all operations in a bulk","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage/bulkidoperations","deprecated":false},{"title":"/bulks/{bulk_id}/execute","summary":"Execute bulk process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage/bulkidexecute","deprecated":false},{"title":"/bulks/{bulk_id}/pause","summary":"Pause bulk process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage/bulkidpause","deprecated":false},{"title":"/bulks/{bulk_id}/resume","summary":"Resume bulk process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage/bulkidresume","deprecated":false},{"title":"/bulks/{bulk_id}/cancel","summary":"Cancel bulk process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage/bulkidcancel","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/UserPredefinedRole":{"id":"components/schemas/UserPredefinedRole","kind":"json-schema","title":"UserPredefinedRole","data":{"type":"string","enum":["CARD_ASSIGNEE","CARDS_MANAGEMENT_ROLE","FUNDS_MANAGEMENT_ROLE","ACCESS_MANAGEMENT_ROLE","ADMIN"]}},"components/schemas/BulkProcessesPaged":{"id":"components/schemas/BulkProcessesPaged","kind":"json-schema","title":"BulkProcessesPaged","data":{"properties":{"count":{"description":"Total number of records (excluding limit)","format":"int32","type":"integer"},"bulkProcesses":{"items":{"$ref":"#/components/schemas/BulkProcess"},"type":"array"},"responseCount":{"description":"Total number of records returned in this response","format":"int32","type":"integer"}},"type":"object"}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"type":"string","description":"E-mail Address of the user","format":"email"}},"components/schemas/VerificationCode":{"id":"components/schemas/VerificationCode","kind":"json-schema","title":"VerificationCode","data":{"type":"string","description":"A randomly generated one-time use code used to verify the user's email address or mobile number.","pattern":"^[0-9]{6}$"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/CorporateKybEntitySubmission":{"id":"components/schemas/CorporateKybEntitySubmission","kind":"json-schema","title":"CorporateKybEntitySubmission","data":{"type":"object","description":"Company and ownership-graph information submitted to pre-populate a corporate's KYB. All fields are optional.","properties":{"company":{"$ref":"#/components/schemas/CorporateKybCompanyData"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybCompanyNode"}},"individuals":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybIndividualNode"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybRelation"}}}}},"components/schemas/CorporateKybProfileSubmission":{"id":"components/schemas/CorporateKybProfileSubmission","kind":"json-schema","title":"CorporateKybProfileSubmission","data":{"type":"object","description":"Account-usage profile submitted to pre-populate a corporate's KYB.","properties":{"profile":{"$ref":"#/components/schemas/CorporateKybProfile"}}}},"components/schemas/CorporateKybDocumentForm":{"id":"components/schemas/CorporateKybDocumentForm","kind":"json-schema","title":"CorporateKybDocumentForm","data":{"type":"object","description":"Multipart form for uploading a single KYB supporting document (up to 10MB).","required":["file","documentType"],"properties":{"file":{"type":"string","format":"binary","description":"The document binary. Up to 10MB."},"documentType":{"$ref":"#/components/schemas/KybDocumentType"},"description":{"type":"string","maxLength":500}}}},"components/schemas/CorporateKybDocumentResponse":{"id":"components/schemas/CorporateKybDocumentResponse","kind":"json-schema","title":"CorporateKybDocumentResponse","data":{"type":"object","description":"Reference to the stored KYB document.","required":["reference"],"properties":{"reference":{"type":"string","maxLength":100}}}},"components/schemas/ManufacturingState":{"id":"components/schemas/ManufacturingState","kind":"json-schema","title":"ManufacturingState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information on the manufacturing of the physical card, 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":"text","inline":true,"attributes":{"content":"REQUESTED: The upgrade of the card to physical has been requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENT_FOR_FULFILLMENT - The card has been sent for printing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERED: The card has been received and activated by the recipient."},"children":[]}]}]}]}],"enum":["REQUESTED","SENT_FOR_FULFILLMENT","DISPATCHED","DELIVERED"]}},"components/schemas/SourceInstrumentType":{"id":"components/schemas/SourceInstrumentType","kind":"json-schema","title":"SourceInstrumentType","data":{"type":"string","enum":["managed_accounts"]}},"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"type":"string","pattern":"^[0-9]+$"}},"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest":{"id":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameRequest","kind":"json-schema","title":"OutgoingWireTransferUpdateBeneficiaryNameRequest","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new beneficiary name. Mutually exclusive with acceptVerifiedName. For FasterPayments/BACS: max 140 chars matching pattern ^[a-zA-Z0-9/-?:().,'+\\s#=!\"%&"},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<>;{@\\r\\n]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$. For IBAN: max 150 chars."},"children":[]}]}]}]},"acceptVerifiedName":{"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 true to accept the account name returned with a CLOSE_MATCH or EXACT_MATCH VoP/CoP result. Mutually exclusive with name."},"children":[]}]}]}]}}}},"components/schemas/CorrespondentBankingOwtState":{"id":"components/schemas/CorrespondentBankingOwtState","kind":"json-schema","title":"CorrespondentBankingOwtState","data":{"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 correspondent bank transfer transaction, 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":"text","inline":true,"attributes":{"content":"INVALID: The transfer has failed initial validation checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The transfer requires the completion of a transaction confirmation challenge before it can be submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED: The transfer has been submitted to the sending financial institution for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The transfer that was submitted was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The transfer that was submitted has been approved and is being processed by the sending financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the transfer, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The requested funds have been sent from the source instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The transfer has been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The transfer will be executed at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled transfer has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CONFIRMATION: The transfer requires a manual confirmation by the user before proceeding."},"children":[]}]}]}]}],"type":"string","enum":["INVALID","PENDING_CHALLENGE","SUBMITTED","REJECTED","APPROVED","FAILED","COMPLETED","RETURNED","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/BeneficiaryBatchState":{"id":"components/schemas/BeneficiaryBatchState","kind":"json-schema","title":"BeneficiaryBatchState","data":{"type":"string","enum":["INITIALISED","FAILED","PENDING_CHALLENGE","CHALLENGE_FAILED","CHALLENGE_COMPLETED","COMPLETED"]}},"components/schemas/BeneficiaryBatchOperation":{"id":"components/schemas/BeneficiaryBatchOperation","kind":"json-schema","title":"BeneficiaryBatchOperation","data":{"type":"string","enum":["CREATE","REMOVE"]}},"components/schemas/RbacRole":{"id":"components/schemas/RbacRole","kind":"json-schema","title":"RbacRole","data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"name":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/Mobile":{"id":"components/schemas/Mobile","kind":"json-schema","title":"Mobile","data":{"required":["number","countryCode"],"type":"object","properties":{"countryCode":{"maxLength":4,"minLength":1,"type":"string","pattern":"^\\+[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country code of the user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"pattern":"^[0-9]{1,12}$","type":"string","description":"The mobile number of the user - excluding country code."}}}},"components/schemas/Date":{"id":"components/schemas/Date","kind":"json-schema","title":"Date","data":{"required":["year","month","day"],"type":"object","properties":{"year":{"type":"integer","format":"int32","maximum":2100,"minimum":1900},"month":{"type":"integer","format":"int32","maximum":12,"minimum":1},"day":{"type":"integer","format":"int32","maximum":31,"minimum":1}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"string","description":"The tag field is a custom field that can be used to search and filter.","maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$"}},"components/schemas/UserLocale":{"id":"components/schemas/UserLocale","kind":"json-schema","title":"UserLocale","data":{"type":"string","pattern":"^[a-z]{2}(-[A-Z]{2})?$","description":"BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.\n","maxLength":5,"example":"en-GB"}},"components/schemas/Brand":{"id":"components/schemas/Brand","kind":"json-schema","title":"Brand","data":{"type":"string","pattern":"^[a-zA-Z0-9]+$","description":"Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.\n","maxLength":25}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","pattern":"^[0-9]+$"}},"components/schemas/UpdateCardLevelSpendRules":{"id":"components/schemas/UpdateCardLevelSpendRules","kind":"json-schema","title":"UpdateCardLevelSpendRules","data":{"allOf":[{"$ref":"#/components/schemas/CardLevelSpendRules"},{"type":"object","properties":{"updateSpendLimitMethod":{"$ref":"#/components/schemas/SpendLimitUpdateMethod"}}}]}},"components/schemas/ProfileId":{"id":"components/schemas/ProfileId","kind":"json-schema","title":"ProfileId","data":{"type":"string","description":"The profile Id which a specific identity, instrument or transaction type is linked to.\n\nProfiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.\n\nYou can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.\n\nProfile Ids can be found in the Multi Portal, in the API Credentials page.\n","pattern":"^[0-9]+$"}},"components/schemas/InstrumentId":{"id":"components/schemas/InstrumentId","kind":"json-schema","title":"InstrumentId","data":{"required":["id","type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/InstrumentType"}}}},"components/schemas/CurrencyAmount":{"id":"components/schemas/CurrencyAmount","kind":"json-schema","title":"CurrencyAmount","data":{"required":["currency","amount"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"integer","format":"int64","description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.\n"}},"description":"The object representing a monetary amount in a particular currency."}},"components/schemas/ScheduledTimestamp":{"id":"components/schemas/ScheduledTimestamp","kind":"json-schema","title":"ScheduledTimestamp","data":{"pattern":"^[0-9]+$","type":"string","description":"The epoch timestamp at which the transaction is scheduled to be executed."}},"components/schemas/SendCreateRequest":{"id":"components/schemas/SendCreateRequest","kind":"json-schema","title":"SendCreateRequest","data":{"required":["profileId","source","destination","destinationAmount"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"source":{"$ref":"#/components/schemas/InstrumentId"},"destination":{"oneOf":[{"$ref":"#/components/schemas/InstrumentId"},{"$ref":"#/components/schemas/BeneficiaryId"}]},"destinationAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"description":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":"The description details that are passed to the beneficiary."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"}}}},"components/schemas/OutgoingWireTransferCreateRequest":{"id":"components/schemas/OutgoingWireTransferCreateRequest","kind":"json-schema","title":"OutgoingWireTransferCreateRequest","data":{"required":["destinationBeneficiary","profileId","sourceInstrument","transferAmount"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"sourceInstrument":{"description":"The managed account from which funds will be collected.","required":["type","id"],"type":"object","properties":{"type":{"type":"string","enum":["managed_accounts"]},"id":{"type":"string","pattern":"^[0-9]+$"}}},"transferAmount":{"description":"The amount, in same currency as source and destination, that was transferred from the source.","$ref":"#/components/schemas/CurrencyAmount"},"purpose":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purpose of the payment. Mandatory for wire transfers executed over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details are passed to the beneficiary as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" . This field is mandatory for wire transfers executed over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SWIFT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The allowed length is dependent on the payment type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters. An extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]}]},"destinationBeneficiary":{"oneOf":[{"$ref":"#/components/schemas/OutgoingWireTransferBeneficiary"},{"$ref":"#/components/schemas/SEPABeneficiary"},{"$ref":"#/components/schemas/SWIFTBeneficiary"},{"$ref":"#/components/schemas/RIXBeneficiary"},{"$ref":"#/components/schemas/FasterPaymentsBeneficiary"},{"$ref":"#/components/schemas/BeneficiaryId"},{"$ref":"#/components/schemas/ExternalAccountId"}]},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"}}}},"components/schemas/LinkedAccount":{"id":"components/schemas/LinkedAccount","kind":"json-schema","title":"LinkedAccount","data":{"required":["id","profileId","name","country","state"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the linked account.","pattern":"^[0-9]+$"},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"minLength":1,"maxLength":50,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},"name":{"minLength":1,"maxLength":100,"type":"string","description":"The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.\n"},"type":{"$ref":"#/components/schemas/AccountType"},"currency":{"$ref":"#/components/schemas/Currency"},"country":{"description":"The country of the bank or institution at which the account is held.","type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"accountReference":{"description":"The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.","oneOf":[{"$ref":"#/components/schemas/AccountNumberAndSortCode"},{"$ref":"#/components/schemas/Iban"},{"$ref":"#/components/schemas/AccountDescriptor"}]},"state":{"$ref":"#/components/schemas/LinkedAccountState"},"creationTimestamp":{"description":"The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.","type":"integer","format":"int64"},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"}}}},"components/schemas/UnknownSenderAccount":{"id":"components/schemas/UnknownSenderAccount","kind":"json-schema","title":"UnknownSenderAccount","data":{"type":"object","properties":{"name":{"type":"string"},"accountReference":{"oneOf":[{"$ref":"#/components/schemas/Iban"},{"$ref":"#/components/schemas/AccountNumberAndSortCode"},{"$ref":"#/components/schemas/AccountDescriptor"}]}}}},"components/schemas/ManagedAccount":{"id":"components/schemas/ManagedAccount","kind":"json-schema","title":"ManagedAccount","data":{"required":["id","profileId","friendlyName","currency","balances","creationTimestamp","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of a Managed Account."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"minLength":1,"maxLength":50,"type":"string","description":"The friendly name given to the managed account."},"currency":{"$ref":"#/components/schemas/Currency"},"balances":{"$ref":"#/components/schemas/ManagedInstrumentBalance"},"state":{"$ref":"#/components/schemas/ManagedInstrumentState"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the managed account was created, expressed in Epoch timestamp using millisecond precision."},"lowBalanceThreshold":{"$ref":"#/components/schemas/AccountLowBalanceThreshold"}}}},"components/schemas/Corporate":{"id":"components/schemas/Corporate","kind":"json-schema","title":"Corporate","data":{"required":["id","profileId","rootUser","company","ipAddress","baseCurrency","creationTimestamp"],"type":"object","properties":{"id":{"description":"The unique identifier of the Corporate Identity.","$ref":"#/components/schemas/IdentityId"},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"rootUser":{"description":"The root user of the Corporate Identity.","$ref":"#/components/schemas/CorporateRootUser"},"company":{"required":["name","type","countryOfRegistration"],"type":"object","properties":{"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"type":{"$ref":"#/components/schemas/CompanyType"},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The company registration number."},"registeredAddress":{"$ref":"#/components/schemas/LegalAddress"},"businessAddress":{"description":"The address where the business is based.","$ref":"#/components/schemas/Address"},"countryOfRegistration":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of company registration in ISO 3166 alpha-2."},"incorporatedOn":{"description":"The company's date of incorporation","$ref":"#/components/schemas/Date"}}},"industry":{"$ref":"#/components/schemas/Industry"},"sourceOfFunds":{"$ref":"#/components/schemas/CorporateSourceOfFunds"},"sourceOfFundsOther":{"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 source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}],"deprecated":true},"acceptedTerms":{"type":"boolean","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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the root user has accepted the terms and conditions."},"children":[]}]}]}]},"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the user doing the registration."},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"feeGroup":{"type":"string","description":"Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field."},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the Corporate was created, expressed in Epoch timestamp using millisecond precision."},"retailQualifier":{"type":"string","description":"Indicates the type of corporate entity based on its retail status.","enum":["RETAIL","NON_RETAIL","UNKNOWN"]}}}},"components/schemas/Consumer":{"id":"components/schemas/Consumer","kind":"json-schema","title":"Consumer","data":{"required":["id","profileId","rootUser","ipAddress","creationTimestamp"],"type":"object","properties":{"id":{"description":"The unique identifier of the Consumer Identity.","$ref":"#/components/schemas/IdentityId"},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"rootUser":{"description":"The root user of the Consumer Identity.","$ref":"#/components/schemas/ConsumerRootUser"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when this consumer was created, expressed in Epoch timestamp using millisecond precision."},"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the consumer user doing the registration."},"acceptedTerms":{"type":"boolean","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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the consumer root user has accepted the terms and conditions."},"children":[]}]}]}]},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"feeGroup":{"type":"string","description":"The fee group which the consumer is bound to."},"sourceOfFunds":{"$ref":"#/components/schemas/ConsumerSourceOfFunds"},"sourceOfFundsOther":{"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 source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}],"deprecated":true}}}},"components/schemas/CardAuthorisationEvent":{"id":"components/schemas/CardAuthorisationEvent","kind":"json-schema","title":"CardAuthorisationEvent","data":{"required":["cardId","authorisationType","merchantData","owner","sourceAmount","transactionAmount","totalTransactionCost","transactionId","transactionTimestamp"],"type":"object","properties":{"cardId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the card on which an authorisation is being performed"},"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"The id of this transaction, for reference."},"authorisationType":{"$ref":"#/components/schemas/CardAuthorisationDetailsAuthorisationType","description":"The type of authorisation (Debit or Credit)"},"sourceAmount":{"description":"The amount in the currency of the merchant.","$ref":"#/components/schemas/CurrencyAmount"},"transactionAmount":{"$ref":"#/components/schemas/CurrencyAmount","description":"The amount in the currency of the card."},"totalTransactionCost":{"$ref":"#/components/schemas/CurrencyAmount","description":"The total amount to be deducted in the currency of the card. This is the summation of the transaction amount, forex padding and forex fees."},"transactionTimestamp":{"type":"integer","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision.","format":"int64"},"merchantData":{"$ref":"#/components/schemas/MerchantData","description":"Merchant related information"},"owner":{"$ref":"#/components/schemas/IdentityId","description":"The owner of the card"},"cardholderPresent":{"$ref":"#/components/schemas/CardHolderPresent","description":"Optional detail indicating if the card holder was present when the authorisation occurred."},"cardPresent":{"type":"boolean","description":"Optional detail indicating if the card was present when the authorisation occurred."},"authCode":{"maxLength":6,"minLength":1,"type":"string","description":"The authorisation code associated with this authorisation."},"forexPadding":{"description":"The forex padding amount, if any, that has been included in the transactionAmount.  Forex padding is extra amount blocked to cater for currency fluctuation.","$ref":"#/components/schemas/CurrencyAmount"},"forexFee":{"description":"The forex fee, if set, that is included in the transactionAmount.","$ref":"#/components/schemas/CurrencyAmount"},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card can be created in prepaid mode or debit mode."},"children":[]}]}]},{"$$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 prepaid mode card has its own balance and can have funds transferred to or from it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A debit mode card does not have its own balance but will be able to spend funds belonging to its parent managed account, subject to a configurable spend limit."},"children":[]}]}]}]}]},"transactionType":{"$ref":"#/components/schemas/CardAuthorisationDetailsTransactionType","description":"The fine-grained transaction classification, e.g. ATM cash withdrawal, account funding transaction, original credit transaction."}},"discriminator":{"propertyName":"mode","mapping":{"PREPAID_MODE":"#/components/schemas/PrepaidModeCardAuthorisationEvent","DEBIT_MODE":"#/components/schemas/DebitModeCardAuthorisationEvent"}}}},"components/schemas/SensitivePassword":{"id":"components/schemas/SensitivePassword","kind":"json-schema","title":"SensitivePassword","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 user's password or passcode used to log in a user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passwords must be:"},"children":[]}]}]},{"$$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":"minimum 8 characters for end-users (Consumers and Corporates); 12 characters for others"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maximum 30 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include a lowercase character"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include an uppercase character"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include a digit and a special character"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"different from any of the 5 last such passwords used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-PCI compliant integrations, the password submitted must be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tokenised"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["value"],"properties":{"value":{"maxLength":100,"type":"string","format":"password"}}}},"components/schemas/IdentityId":{"id":"components/schemas/IdentityId","kind":"json-schema","title":"IdentityId","data":{"required":["type","id"],"type":"object","properties":{"type":{"enum":["CONSUMER","CORPORATE"],"type":"string","description":"Indicates the identity type."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier for the identity."}}}},"components/schemas/Nonce":{"id":"components/schemas/Nonce","kind":"json-schema","title":"Nonce","data":{"type":"string","description":"A randomly generated one-time use code.","pattern":"^[0-9]{6}$"}},"components/schemas/MultipleSCAResourceType":{"id":"components/schemas/MultipleSCAResourceType","kind":"json-schema","title":"MultipleSCAResourceType","data":{"type":"string","description":"The operation type upon which an SCA Challenge is being contested.\n","enum":["outgoing_wire_transfers","sends","linked_account_declaration","correspondent_bank_transfers"]}},"components/schemas/BulkProcessExecute":{"id":"components/schemas/BulkProcessExecute","kind":"json-schema","title":"BulkProcessExecute","data":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/BulkProcessMode"},"webhookInterval":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The count of operations after which a Bulk Process Progress will be sent. For example, if set to 10, a webhook will be sent after every 10th operation is attempted. The minimum value fo count is 25% of all operations. If a value below this is entered, a webhook will only be sent for each 25% of operations attempted (i.e. 4 webhooks per Bulk Process)."},"children":[]}]}]}],"format":"int32","type":"integer"}}}},"components/schemas/CreateCorporateRootUser":{"id":"components/schemas/CreateCorporateRootUser","kind":"json-schema","title":"CreateCorporateRootUser","data":{"required":["name","surname","email","mobile","companyPosition"],"type":"object","description":"The root user needs to be a director or a legal representative of the corporate that is being onboarded - this user cannot be deactivated.\n\nRoot users need to verify their email address and mobile number, as well as complete KYC as part of the Corporate's due diligence process.\n","properties":{"name":{"maxLength":50,"type":"string","description":"The first name of the root user."},"surname":{"maxLength":50,"type":"string","description":"The last name of the root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"companyPosition":{"$ref":"#/components/schemas/CompanyPosition"},"dateOfBirth":{"description":"Date of birth of the root user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}}},"components/schemas/CreateCorporateRootUserId":{"id":"components/schemas/CreateCorporateRootUserId","kind":"json-schema","title":"CreateCorporateRootUserId","data":{"required":["id"],"type":"object","description":"Identifies an existing root user to be linked to the new identity being created.\n\nUse this instead of providing the root user's details when the root user has already been created.\n","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user."}}}},"components/schemas/CompanyType":{"id":"components/schemas/CompanyType","kind":"json-schema","title":"CompanyType","data":{"type":"string","description":"Supported company types - if company type is not listed, please contact our support team to check if the company type can be supported.","enum":["SOLE_TRADER","LLC","PUBLIC_LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP","NON_PROFIT_ORGANISATION"]}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"required":["addressLine1","city","postCode","country"],"type":"object","properties":{"addressLine1":{"minLength":1,"maxLength":150,"type":"string","description":"The first line of the address."},"addressLine2":{"maxLength":150,"type":"string","description":"The second line of the address."},"city":{"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post code associated with the address."},"state":{"maxLength":50,"type":"string","description":"The state of the address."},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of the address expressed in ISO 3166 alpha-2 format."}}}},"components/schemas/Industry":{"id":"components/schemas/Industry","kind":"json-schema","title":"Industry","data":{"type":"string","description":"The industry of the identity.","deprecated":true,"enum":["ACCOUNTING","AUDIT","FINANCE","PUBLIC_SECTOR_ADMINISTRATION","ART_ENTERTAINMENT","AUTO_AVIATION","BANKING_LENDING","BUSINESS_CONSULTANCY_LEGAL","CONSTRUCTION_REPAIR","EDUCATION_PROFESSIONAL_SERVICES","INFORMATIONAL_TECHNOLOGIES","TOBACCO_ALCOHOL","GAMING_GAMBLING","MEDICAL_SERVICES","MANUFACTURING","PR_MARKETING","PRECIOUS_GOODS_JEWELRY","NON_GOVERNMENTAL_ORGANIZATION","INSURANCE_SECURITY","RETAIL_WHOLESALE","TRAVEL_TOURISM","FREELANCER"]}},"components/schemas/CorporateSourceOfFunds":{"id":"components/schemas/CorporateSourceOfFunds","kind":"json-schema","title":"CorporateSourceOfFunds","data":{"type":"string","description":"The corporate's source of funds.","deprecated":true,"enum":["LABOUR_CONTRACT","CIVIL_CONTRACT","RENT","FUNDS_FROM_OTHER_AUXILIARY_SOURCES","SALE_OF_MOVABLE_ASSETS","SALE_OF_REAL_ESTATE","ORDINARY_BUSINESS_ACTIVITY","DIVIDENDS","LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS","LOAN_FROM_THIRD_PARTIES","SALE_OF_COMPANY_SHARES_BUSINESS","OTHER","DONATION","INHERITANCE","ORIGIN_OF_FUNDS_UNKNOWN"]}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","description":"The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.","maxLength":3,"minLength":3,"pattern":"^[A-Z]*$"}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"required":["feeType","source"],"type":"object","properties":{"feeType":{"type":"string","description":"The fee type as defined in the Multi Portal."},"source":{"description":"The instrument from where the fee should be deducted.","$ref":"#/components/schemas/InstrumentId"}}}},"components/schemas/Occupation":{"id":"components/schemas/Occupation","kind":"json-schema","title":"Occupation","data":{"type":"string","description":"The industry of the identity.","deprecated":true,"enum":["ACCOUNTING","AUDIT","FINANCE","PUBLIC_SECTOR_ADMINISTRATION","ART_ENTERTAINMENT","AUTO_AVIATION","BANKING_LENDING","BUSINESS_CONSULTANCY_LEGAL","CONSTRUCTION_REPAIR","EDUCATION_PROFESSIONAL_SERVICES","INFORMATIONAL_TECHNOLOGIES","TOBACCO_ALCOHOL","GAMING_GAMBLING","MEDICAL_SERVICES","MANUFACTURING","PR_MARKETING","PRECIOUS_GOODS_JEWELRY","NON_GOVERNMENTAL_ORGANIZATION","INSURANCE_SECURITY","RETAIL_WHOLESALE","TRAVEL_TOURISM","FREELANCER","STUDENT","UNEMPLOYED","RETIRED","OTHER"]}},"components/schemas/AddressWithCountryRequired":{"id":"components/schemas/AddressWithCountryRequired","kind":"json-schema","title":"AddressWithCountryRequired","data":{"required":["country"],"type":"object","description":"The address, with none of the separate fields being set as required.","properties":{"addressLine1":{"type":"string","description":"The first line of the address."},"addressLine2":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city of the address."},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post code associated with the address."},"state":{"maxLength":50,"type":"string","description":"The state of the address."},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of the address expressed in ISO 3166 alpha-2 format."}}}},"components/schemas/Nationality":{"id":"components/schemas/Nationality","kind":"json-schema","title":"Nationality","data":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"Nationality of the user - using ISO 3166 alpha-2."}},"components/schemas/ConsumerSourceOfFunds":{"id":"components/schemas/ConsumerSourceOfFunds","kind":"json-schema","title":"ConsumerSourceOfFunds","data":{"deprecated":true,"type":"string","description":"The consumer's source of funds.","enum":["PERSONAL_SAVINGS","FAMILY_SAVINGS","LABOUR_CONTRACT","CIVIL_CONTRACT","RENT","FUNDS_FROM_OTHER_AUXILIARY_SOURCES","SALE_OF_MOVABLE_ASSETS","SALE_OF_REAL_ESTATE","ORDINARY_BUSINESS_ACTIVITY","DIVIDENDS","LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS","LOAN_FROM_THIRD_PARTIES","INHERITANCE","SALE_OF_COMPANY_SHARES_BUSINESS","OTHER"]}},"components/schemas/KycLevel":{"id":"components/schemas/KycLevel","kind":"json-schema","title":"KycLevel","data":{"deprecated":true,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KYC level, which determines what KYC information will be requested from the consumer:"},"children":[]}]}]},{"$$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":"KYC_LEVEL_1: The most basic level of KYC required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC_LEVEL_2: Full due diligence level 2"},"children":[]}]}]}]}],"enum":["KYC_LEVEL_1","KYC_LEVEL_2"]}},"components/schemas/CreateLinkedAccountRequest":{"id":"components/schemas/CreateLinkedAccountRequest","kind":"json-schema","title":"CreateLinkedAccountRequest","data":{"required":["name","accountReference","country","type"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/LinkedAccountProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"name":{"description":"The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.\n","type":"string","minLength":1,"maxLength":100},"type":{"$ref":"#/components/schemas/AccountType"},"accountReference":{"description":"The IBAN, or Account Number and Sort Code, or Account Descriptor of the account held at the external bank or payment service provider.","oneOf":[{"$ref":"#/components/schemas/Iban"},{"$ref":"#/components/schemas/AccountNumberAndSortCode"},{"$ref":"#/components/schemas/AccountDescriptor"}]},"country":{"description":"The country of the bank or institution at which the account is held.","type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"friendlyName":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"type":"string","maxLength":50},"currency":{"oneOf":[{"$ref":"#/components/schemas/Currency"}]}}}},"components/schemas/AccountLowBalanceThreshold":{"id":"components/schemas/AccountLowBalanceThreshold","kind":"json-schema","title":"AccountLowBalanceThreshold","data":{"type":"integer","format":"int64","description":"Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account."}},"components/schemas/ManagedCardRequest":{"id":"components/schemas/ManagedCardRequest","kind":"json-schema","title":"ManagedCardRequest","data":{"required":["profileId","friendlyName","nameOnCard","billingAddress","mode"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"maxLength":50,"minLength":1,"type":"string","description":"The friendly name for the card."},"nameOnCard":{"maxLength":27,"minLength":1,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"The card holder's name for the card.\n\nThis may be verified by merchants when the card is used online. For Physical cards, this field will be printed on the card.\nThe maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards.\n"},"nameOnCardLine2":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards."},"cardholderMobileNumber":{"description":"The mobile number including country code of the card holder.\n\nFor transactions that require a 3DS challenge, an SMS with a code will be sent on this number, to be entered during an online purchase.\n","maxLength":15,"minLength":5,"pattern":"^\\+[0-9]+$","type":"string","deprecated":true},"billingAddress":{"description":"The billing address set for the card holder. This may be verified by merchants when the card is used online.","$ref":"#/components/schemas/BillingAddress"},"digitalWallets":{"description":"The Card Tokenisation details","$ref":"#/components/schemas/DigitalWallets"},"authForwardingDefaultTimeoutDecision":{"type":"string","description":"Default decision for auth forwarding on timeout","enum":["APPROVE","DECLINE"]},"threeDSecureAuthConfig":{"description":"3DS details for card creation","$ref":"#/components/schemas/ThreeDSecureAuthConfig"},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card can be created in prepaid mode or debit mode."},"children":[]}]}]},{"$$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 prepaid mode card has its own balance and can have funds transferred to or from it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A debit mode card does not have its own balance but will be able to spend funds belonging to its parent managed account, subject to a configurable spend limit."},"children":[]}]}]}]}]},"externalData":{"$ref":"#/components/schemas/ExternalData"},"renewalType":{"$ref":"#/components/schemas/CardRenewalType"},"userId":{"$ref":"#/components/schemas/UserId","description":"The Authorised User to be linked to the card, whose authentication details will be used for actions such as 3DS authentication, or manual provisioning to a digital wallet. This field can be used instead of threeDSecureAuthConfig as it better describes the wider scope of possible uses."}},"discriminator":{"propertyName":"mode","mapping":{"PREPAID_MODE":"#/components/schemas/PrepaidModeCardRequest","DEBIT_MODE":"#/components/schemas/DebitModeCardRequest"}}}},"components/schemas/BillingAddress":{"id":"components/schemas/BillingAddress","kind":"json-schema","title":"BillingAddress","data":{"required":["addressLine1","city","postCode","country"],"type":"object","properties":{"addressLine1":{"minLength":1,"maxLength":150,"type":"string","description":"The first line of the address."},"addressLine2":{"maxLength":150,"type":"string","description":"The second line of the address."},"city":{"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post code associated with the address."},"state":{"maxLength":50,"type":"string","description":"The state of the address."},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of the address expressed in ISO 3166 alpha-2 format."}}}},"components/schemas/ExternalData":{"id":"components/schemas/ExternalData","kind":"json-schema","title":"ExternalData","data":{"description":"External data fields, as provided and managed by the caller that are to be stored and associated with a Managed Card instance. This information is not processed or used by Weavr but some of the values could be shown in specific reports and used as filters","type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"value":{"type":"string","minLength":1,"maxLength":100}}},"uniqueItems":true,"maxItems":10}},"components/schemas/DeliveryAddress":{"id":"components/schemas/DeliveryAddress","kind":"json-schema","title":"DeliveryAddress","data":{"required":["name","surname","addressLine1","city","postCode","country"],"type":"object","description":"The delivery address where the physical card is delivered.","properties":{"name":{"maxLength":100,"type":"string"},"surname":{"maxLength":100,"type":"string"},"addressLine1":{"maxLength":50,"minLength":1,"type":"string"},"addressLine2":{"maxLength":50,"minLength":1,"type":"string"},"city":{"maxLength":50,"type":"string"},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string"},"state":{"maxLength":50,"type":"string"},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"Country of the identity in ISO 3166 alpha-2 format."},"contactNumber":{"$ref":"#/components/schemas/PhoneNumber","description":"Mandatory when bulk delivery is selected. Will be printed on the box/packet to assist delivery."}}}},"components/schemas/DeliveryMethod":{"id":"components/schemas/DeliveryMethod","kind":"json-schema","title":"DeliveryMethod","data":{"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 methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used."},"children":[]}]}]}],"enum":["STANDARD_DELIVERY","REGISTERED_MAIL","COURIER","FIRST_CLASS_MAIL"]}},"components/schemas/DigitalWallets":{"id":"components/schemas/DigitalWallets","kind":"json-schema","title":"DigitalWallets","data":{"type":"object","properties":{"pushProvisioningEnabled":{"type":"boolean","description":"Indicates whether the card is enabled for push provisioning in a digital wallet."},"walletsEnabled":{"type":"boolean","description":"Indicates whether the card is enabled for tokenisation in a digital wallet."},"artworkReference":{"type":"string","description":"The artwork reference that will be used if the card is enabled for tokenisation in a digital wallet."}}}},"components/schemas/ThreeDSecureAuthConfig":{"id":"components/schemas/ThreeDSecureAuthConfig","kind":"json-schema","title":"ThreeDSecureAuthConfig","data":{"deprecated":true,"type":"object","required":["linkedUserId","primaryChannel"],"properties":{"linkedUserId":{"type":"string","description":"The Authorised user whose authentication / billing details will be reflected on the card for verification purposes such as 3ds.","pattern":"^[0-9]+$","deprecated":true},"primaryChannel":{"type":"string","description":"Primary Authentication Method","enum":["OTP_SMS","BIOMETRICS","TWILIO_AUTHY"]},"fallbackChannel":{"type":"string","description":"Fallback Authentication Method","enum":["OTP_SMS"]}}}},"components/schemas/BulkCardDelivery":{"id":"components/schemas/BulkCardDelivery","kind":"json-schema","title":"BulkCardDelivery","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All cards marked as bulk and ordered within the fulfilment centre’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200."},"children":[]}]}]}]}},"components/schemas/PhysicalCardActivationCode":{"id":"components/schemas/PhysicalCardActivationCode","kind":"json-schema","title":"PhysicalCardActivationCode","data":{"pattern":"^[0-9]{1,6}$","type":"string"}},"components/schemas/CardRenewalType":{"id":"components/schemas/CardRenewalType","kind":"json-schema","title":"CardRenewalType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the card will be handled once it is close to expiring."},"children":[]}]}]},{"$$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":"RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_RENEW: Once the expiry date is reached, the card is destroyed."},"children":[]}]}]}]}],"enum":["RENEW","NO_RENEW"],"type":"string"}},"components/schemas/CardLevelSpendRules":{"id":"components/schemas/CardLevelSpendRules","kind":"json-schema","title":"CardLevelSpendRules","data":{"allOf":[{"$ref":"#/components/schemas/BaseCardLevelSpendRules"},{"type":"object","properties":{"minTransactionAmount":{"type":"integer","minimum":0,"format":"int64","description":"The minimum transaction amount, in card currency, that is allowed. If the transaction amount is less than this value, then the transaction will be declined."},"maxTransactionAmount":{"type":"integer","minimum":0,"format":"int64","description":"The maximum transaction amount, in card currency, that is allowed. If the transaction amount is greater than this value, then the transaction will be declined."}}}]}},"components/schemas/SensitivePin":{"id":"components/schemas/SensitivePin","kind":"json-schema","title":"SensitivePin","data":{"type":"object","description":"The PIN used for in-person transactions done with physical cards.\n\nUnless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card's PIN will be tokenised.\n\nTo show the PIN to your user, you need to embed the Display Card PIN UI Component in your application. This accepts the tokenised PIN and shows the plain text PIN to the user on screen.\n","required":["value"],"properties":{"value":{"minLength":4,"maxLength":24,"type":"string"}}}},"components/schemas/TransactionBulkCancelRequest":{"id":"components/schemas/TransactionBulkCancelRequest","kind":"json-schema","title":"TransactionBulkCancelRequest","data":{"required":["cancellations"],"type":"object","properties":{"cancellations":{"type":"array","description":"Contains the details of the transactions to be cancelled.","items":{"$ref":"#/components/schemas/TransactionCancelRequest"}}}}},"components/schemas/TransactionSingleCancelRequest":{"id":"components/schemas/TransactionSingleCancelRequest","kind":"json-schema","title":"TransactionSingleCancelRequest","data":{"type":"object","properties":{"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"}}}},"components/schemas/CorrespondentBankingOwtCreateRequest":{"id":"components/schemas/CorrespondentBankingOwtCreateRequest","kind":"json-schema","title":"CorrespondentBankingOwtCreateRequest","data":{"required":["profileId","sourceInstrument","amount","originator","beneficiary","purpose"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"sourceInstrument":{"description":"The managed account from which funds will be collected.","required":["type","id"],"type":"object","properties":{"type":{"type":"string","enum":["managed_accounts"]},"id":{"type":"string","pattern":"^[0-9]+$"}}},"amount":{"description":"The amount to transfer.","$ref":"#/components/schemas/CurrencyAmount"},"originator":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingIndividualOriginator"},{"$ref":"#/components/schemas/CorrespondentBankingBusinessOriginator"}]},"beneficiary":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingSEPABeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingRIXBeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingFasterPaymentsBeneficiary"}]},"purpose":{"type":"string","maxLength":255,"description":"The purpose of the payment."},"description":{"maxLength":35,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details are passed to the beneficiary as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is mandatory for wire transfers executed over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The allowed length is dependent on the payment type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters. An extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]}]},"externalData":{"type":"array","description":"Additional external data as key-value pairs.","items":{"$ref":"#/components/schemas/CorrespondentBankingExternalData"}},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"}}}},"components/schemas/BasicBeneficiary":{"id":"components/schemas/BasicBeneficiary","kind":"json-schema","title":"BasicBeneficiary","data":{"required":["trustLevel","beneficiaryInformation","beneficiaryDetails"],"type":"object","properties":{"trustLevel":{"description":"The value that determines whether a Beneficiary is trusted or not.","$ref":"#/components/schemas/BeneficiaryTrustLevel"},"externalRefs":{"description":"The id of the entity as it is represented on the caller system.","type":"array","items":{"type":"string"}},"group":{"description":"A custom field that can be used to categorise a beneficiary for easier searching and filtering.","type":"string","maxLength":150},"beneficiaryInformation":{"description":"The object representing the beneficiary details.","oneOf":[{"$ref":"#/components/schemas/BusinessBeneficiaryType"},{"$ref":"#/components/schemas/ConsumerBeneficiaryType"}]},"beneficiaryDetails":{"description":"The object representing the beneficiary instrument details.","oneOf":[{"$ref":"#/components/schemas/InstrumentDetailsBeneficiary"},{"$ref":"#/components/schemas/BankAccountDetailsBeneficiary"}]}}}},"components/schemas/TokenType":{"id":"components/schemas/TokenType","kind":"json-schema","title":"TokenType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The auth token received can only be used to access the following endpoints:"},"children":[]}]}]},{"$$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":"/identities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/access_token"},"children":[]}]}]}]}],"enum":["NO_TYPE","AUTH","ACCESS"]}},"components/schemas/CredentialId":{"id":"components/schemas/CredentialId","kind":"json-schema","title":"CredentialId","data":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ROOT","USER","API_CLIENT"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}}},"components/schemas/SyntaxError":{"id":"components/schemas/SyntaxError","kind":"json-schema","title":"SyntaxError","data":{"type":"object","description":"Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.","properties":{"invalidFields":{"type":"array","items":{"type":"object","properties":{"params":{"type":"array","items":{"type":"string"}},"fieldName":{"type":"string"},"error":{"type":"string","enum":["REQUIRED","HAS_TEXT","REQUIRES","SIZE","RANGE","IN","NOT_IN","REGEX","EXACTLY","AT_LEAST","AT_MOST","ALL_OR_NONE"]}}}}}}},"components/schemas/TokenError":{"id":"components/schemas/TokenError","kind":"json-schema","title":"TokenError","data":{"description":"The used token is expired or not found","type":"object","properties":{"errorCode":{"type":"string","enum":["TOKEN_EXPIRED","TOKEN_NOT_FOUND"]}}}},"components/schemas/PasswordInfo":{"id":"components/schemas/PasswordInfo","kind":"json-schema","title":"PasswordInfo","data":{"required":["identityId"],"type":"object","description":"Additional information related to the user's password.","properties":{"identityId":{"description":"The identity to which the user's password information belongs to.","$ref":"#/components/schemas/IdentityId"},"expiryDate":{"minimum":0,"type":"integer","format":"int64","description":"The millisecond timestamp indicating when the password will expire. If 0, then this password will not expire."}}}},"components/schemas/PasswordValidateComplexityIssue":{"id":"components/schemas/PasswordValidateComplexityIssue","kind":"json-schema","title":"PasswordValidateComplexityIssue","data":{"description":"A single password complexity rule that the submitted password failed.","properties":{"code":{"$ref":"#/components/schemas/PasswordValidateComplexityIssueCode"},"requirement":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value required by the profile: minimum length (PASSWORD_TOO_SHORT), maximum length (PASSWORD_TOO_LONG) or required number of character types (PASSWORD_TOO_SIMPLE)."},"children":[]}]}]}],"type":"integer"},"actual":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the submitted password: its length (PASSWORD_TOO_SHORT / PASSWORD_TOO_LONG) or the number of character types present (PASSWORD_TOO_SIMPLE)."},"children":[]}]}]}],"type":"integer"}},"type":"object"}},"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"An authorisation token to be used in the Authorization header for secured operations."}}}},"components/schemas/SCAFactor":{"id":"components/schemas/SCAFactor","kind":"json-schema","title":"SCAFactor","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SCAChallengeType"},"status":{"$ref":"#/components/schemas/SCAFactorStatus"},"channel":{"$ref":"#/components/schemas/SCAChannel"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"required":["id","email","name","surname","identity","active"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user."},"identity":{"description":"The identity that the user belongs to.","$ref":"#/components/schemas/IdentityId"},"name":{"maxLength":100,"type":"string","description":"The first name of the user."},"surname":{"maxLength":100,"type":"string","description":"The last name of the user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"active":{"type":"boolean","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 user. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute is false, then the user will not be able to log in."},"children":[]}]}]}]},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"countryOfResidence":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserPredefinedRole"}}}}},"components/schemas/BulkProcessConflict":{"id":"components/schemas/BulkProcessConflict","kind":"json-schema","title":"BulkProcessConflict","data":{"properties":{"errorCode":{"$ref":"#/components/schemas/BulkProcessConflictErrorCode"}},"type":"object"}},"components/schemas/BulkProcessDetails":{"id":"components/schemas/BulkProcessDetails","kind":"json-schema","title":"BulkProcessDetails","data":{"allOf":[{"$ref":"#/components/schemas/BulkProcess"},{"type":"object","properties":{"operationStatusCounts":{"type":"array","items":{"$ref":"#/components/schemas/BulkProcessOperationStatusCounts"}}}}]}},"components/schemas/BulkProcessOperationsPaged":{"id":"components/schemas/BulkProcessOperationsPaged","kind":"json-schema","title":"BulkProcessOperationsPaged","data":{"properties":{"count":{"description":"Total number of records (excluding limit)","format":"int32","type":"integer"},"operations":{"items":{"$ref":"#/components/schemas/BulkProcessOperation"},"type":"array"},"responseCount":{"description":"Total number of records returned in this response","format":"int32","type":"integer"}},"type":"object"}},"components/schemas/UserIdentitiesGetResponseSchema":{"id":"components/schemas/UserIdentitiesGetResponseSchema","kind":"json-schema","title":"UserIdentitiesGetResponseSchema","data":{"required":["identities","count","responseCount"],"type":"object","properties":{"identities":{"type":"array","description":"The list of identities available to user.","items":{"$ref":"#/components/schemas/UserIdentity"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}}},"components/schemas/CreatedCorporate":{"id":"components/schemas/CreatedCorporate","kind":"json-schema","title":"CreatedCorporate","data":{"allOf":[{"$ref":"#/components/schemas/Corporate"},{"type":"object","required":["rootUser"],"properties":{"rootUser":{"description":"The root user of the Corporate Identity.","$ref":"#/components/schemas/CreatedCorporateRootUser"}}}]}},"components/schemas/KyiStatus":{"id":"components/schemas/KyiStatus","kind":"json-schema","title":"KyiStatus","data":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"]}},"components/schemas/CorporateKybStatusValue":{"id":"components/schemas/CorporateKybStatusValue","kind":"json-schema","title":"CorporateKybStatusValue","data":{"type":"string","enum":["NEW","PENDING","APPROVED","REJECTED","CLOSED"]}},"components/schemas/KybRun":{"id":"components/schemas/KybRun","kind":"json-schema","title":"KybRun","data":{"type":"object","required":["id","status","runType","startedTimestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Id of the KYB Run."},"regulatoryFi":{"type":"string","description":"The regulatory FI the run verifies the corporate against."},"status":{"description":"The status of the KYB Run.","$ref":"#/components/schemas/KybRunStatus"},"runType":{"description":"Whether the run is the initial onboarding verification or a KYB refresh.","$ref":"#/components/schemas/KybRunType"},"startedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"endedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision. Absent while the run is open."},"notes":{"type":"string","description":"Compliance note attached to the run."}}}},"components/schemas/CorporateKybEntityResponseSchema":{"id":"components/schemas/CorporateKybEntityResponseSchema","kind":"json-schema","title":"CorporateKybEntityResponseSchema","data":{"type":"object","description":"The company and ownership-graph information submitted to pre-populate a corporate's KYB.","properties":{"company":{"$ref":"#/components/schemas/CorporateKybCompanyData"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybCompanyNode"}},"individuals":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybIndividualNode"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybRelation"}},"companyName":{"type":"string","maxLength":255,"description":"The main corporate's name, taken from the corporate record."},"registrationNumber":{"type":"string","maxLength":100,"description":"The main corporate's registration number, taken from the corporate record."},"registrationCountry":{"type":"string","maxLength":2,"description":"The main corporate's registration country, ISO 3166-1 alpha-2."}}}},"components/schemas/CorporateKybProfileResponseSchema":{"id":"components/schemas/CorporateKybProfileResponseSchema","kind":"json-schema","title":"CorporateKybProfileResponseSchema","data":{"type":"object","description":"The account-usage profile submitted to pre-populate a corporate's KYB.","properties":{"profile":{"$ref":"#/components/schemas/CorporateKybProfile"}}}},"components/schemas/CorporateKybDocumentList":{"id":"components/schemas/CorporateKybDocumentList","kind":"json-schema","title":"CorporateKybDocumentList","data":{"type":"object","description":"The documents uploaded to a corporate's KYB.","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybDocument"}}}}},"components/schemas/ChargeFee":{"id":"components/schemas/ChargeFee","kind":"json-schema","title":"ChargeFee","data":{"required":["transactionId","profileId","feeType","source","destination","availableBalanceAdjustment","state","creationTimestamp"],"type":"object","properties":{"transactionId":{"$ref":"#/components/schemas/TransactionId","description":"The unique identifier of the transaction."},"profileId":{"type":"string","description":"The profile Id which a specific identity, instrument or transaction type is linked to."},"feeType":{"type":"string","description":"The fee type as defined in the Multi Portal, and as sent in the request."},"source":{"$ref":"#/components/schemas/InstrumentId"},"availableBalanceAdjustment":{"$ref":"#/components/schemas/CurrencyAmount","description":"The object representing a monetary amount in a particular currency."},"state":{"$ref":"#/components/schemas/TransactionState","description":"The transaction entry state."},"creationTimestamp":{"type":"integer","format":"int64"}}}},"components/schemas/FeeTransactionList":{"id":"components/schemas/FeeTransactionList","kind":"json-schema","title":"FeeTransactionList","data":{"type":"object","description":"A paginated list of fee transactions.","properties":{"fees":{"type":"array","items":{"$ref":"#/components/schemas/FeeTransaction"}},"count":{"type":"integer","format":"int64","description":"The total number of records matching the filter criteria."},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/LinkedAccountVerificationRun":{"id":"components/schemas/LinkedAccountVerificationRun","kind":"json-schema","title":"LinkedAccountVerificationRun","data":{"type":"object","required":["state"],"properties":{"id":{"type":"string","description":"The unique identifier of the linked account verification"},"state":{"description":"The state of the linked account verification","$ref":"#/components/schemas/LinkedAccountVerificationRunState"},"completedTimestamp":{"type":"integer","format":"int64","description":"The timestamp when the verification was completed, expressed in Epoch timestamp using millisecond precision."},"verificationSteps":{"type":"array","items":{"type":"object","properties":{"step":{"$ref":"#/components/schemas/LinkedAccountVerificationStep"},"details":{"oneOf":[{"$ref":"#/components/schemas/LinkedAccountVerificationTransferInstruction"},{"$ref":"#/components/schemas/LinkedAccountMicroDepositVerification"}]},"status":{"$ref":"#/components/schemas/LinkedAccountVerificationStepStatus"},"completedTimestamp":{"type":"integer","format":"int64","description":"The timestamp when the card will be renewed, expressed in Epoch timestamp using millisecond precision."}}}},"overriddenReason":{"type":"string","description":"Optional field for users to provide a reason for overriding the verification steps"}}}},"components/schemas/ManagedAccountIBAN":{"id":"components/schemas/ManagedAccountIBAN","kind":"json-schema","title":"ManagedAccountIBAN","data":{"required":["state","bankAccountDetails"],"type":"object","properties":{"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 Managed Account's IBAN 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":"text","inline":true,"attributes":{"content":"UNALLOCATED: The Managed Account has never been assigned an IBAN. Use the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"managedAccountsIBANUpgrade"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to assign an IBAN to a Managed Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_ALLOCATION: The IBAN is being allocated to the Managed Account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALLOCATED: An IBAN is allocated to the Managed Account."},"children":[]}]}]}]}],"enum":["UNALLOCATED","PENDING_ALLOCATION","ALLOCATED"]},"bankAccountDetails":{"description":"A list of bank account details associated with the IBAN.\nMultiple details can be provided if multiple IBAN providers are supported by your payment model.","type":"array","items":{"required":["beneficiaryNameAndSurname","beneficiaryBank","beneficiaryBankAddress","type","details"],"type":"object","properties":{"beneficiaryNameAndSurname":{"type":"string","description":"The beneficiary name and surname details to be used when initiating a deposit onto the IBAN."},"beneficiaryBank":{"type":"string","description":"The beneficiary bank name to be used when initiating a deposit onto the IBAN."},"beneficiaryBankAddress":{"type":"string","description":"The beneficiary bank address to be used when initiating a deposit onto the IBAN."},"paymentReference":{"type":"string","description":"A reference required by the partner bank to execute a deposit on the managed account.\n\n\nIf provided, make sure that this is included as part of the wire transfer details when initiating a deposit.\n"},"details":{"description":"The bank details required to initiate a deposit on the managed account.\n\nThe details required to deposit on the IBAN vary depending on the wire transfer channel that will be used.\n","anyOf":[{"$ref":"#/components/schemas/IBANDetails"},{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"},{"$ref":"#/components/schemas/SwiftBankDetails"}]}}}}}}},"components/schemas/Statement":{"id":"components/schemas/Statement","kind":"json-schema","title":"Statement","data":{"type":"object","description":"The list of statement entries.","properties":{"entry":{"type":"array","items":{"$ref":"#/components/schemas/StatementEntry"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response.","format":"int32"},"startBalance":{"description":"The start balance amount in the instrument's currency. Empty for debit cards.","$ref":"#/components/schemas/CurrencyAmount"},"endBalance":{"description":"The end balance amount in the instrument's currency. Empty for debit cards.","$ref":"#/components/schemas/CurrencyAmount"},"footer":{"description":"The footer description for the current statement","type":"string"}}}},"components/schemas/StatementEntry":{"id":"components/schemas/StatementEntry","kind":"json-schema","title":"StatementEntry","data":{"required":["transactionAmount","entryState","transactionId","processedTimestamp"],"type":"object","properties":{"transactionId":{"description":"The unique identifier of the transaction.","$ref":"#/components/schemas/TransactionId"},"entryState":{"$ref":"#/components/schemas/StatementEntryState"},"originalAmount":{"description":"The transaction amount as originally requested. The original amount currency may be different from the currency of the instrument.\n\nIn case of purchases, this will indicate the original currency and amount that the merchant requested.\n","$ref":"#/components/schemas/CurrencyAmount"},"forexRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in a different currency from the instrument's currency, the forex rate used will be provided."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"transactionAmount":{"description":"The transaction amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"availableBalanceAdjustment":{"description":"The amount of funds credited or debited on the available balance of the instrument.","$ref":"#/components/schemas/CurrencyAmount"},"actualBalanceAdjustment":{"description":"The amount of funds credited or debited on the actual balance of the instrument.","$ref":"#/components/schemas/CurrencyAmount"},"balanceAfter":{"description":"The balance of the instrument after the transaction was executed.","$ref":"#/components/schemas/CurrencyAmount"},"availableBalanceAfter":{"description":"The available balance of the instrument after the transaction was executed.","$ref":"#/components/schemas/CurrencyAmount"},"actualBalanceAfter":{"description":"The actual balance of the instrument after the transaction was executed.","$ref":"#/components/schemas/CurrencyAmount"},"transactionFee":{"description":"The fee amount that was captured for you (Multi account owner). You can set fees to be taken during transactions in the Multi Portal.","$ref":"#/components/schemas/CurrencyAmount"},"cardholderFee":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee amount that was captured for you (Multi account owner). You can set fees to be taken during transactions in the Multi Portal. This field is deprecated - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"processedTimestamp":{"type":"integer","format":"int64","description":"The timestamp when the transaction was processed by the system, expressed in Epoch timestamp using millisecond precision."},"sourceAmount":{"description":"The source amount of the transaction, if the transaction involves forex.","$ref":"#/components/schemas/CurrencyAmount"},"userCurrencyTransactionDetails":{"description":"The object representing the user transaction's details","$ref":"#/components/schemas/UserCurrencyTransactionDetails"},"additionalFields":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Map of additional fields. Possible values include fee information. The possible entries are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantCategoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantTerminalCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInstrumentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationInstrumentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forexPaddingCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forexPaddingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInstrumentFriendlyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationInstrumentFriendlyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceIdentityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceIdentityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceIdentityName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationIdentityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationIdentityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationIdentityName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorisationState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorisationRelatedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlementRelatedId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeFeeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedTransactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedTransactionIdType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiaryName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiaryAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiaryBankCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantTransactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"systemTransactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorisationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedCardId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forexFeeCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forexFeeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderIban"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandateId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declineReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendRuleFailedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorisationCategory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorisationTransactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/StatementResponse":{"id":"components/schemas/StatementResponse","kind":"json-schema","title":"StatementResponse","data":{"type":"object","description":"A financial statement for an instrument over a given period. Contains only posted/completed\ntransactions where funds have definitively moved (actual balance changed).\nRepeated requests for the same period return the same result.\n","properties":{"openingBalance":{"description":"The balance of the instrument at the start of the statement period.","$ref":"#/components/schemas/CurrencyAmount"},"closingBalance":{"description":"The balance of the instrument at the end of the statement period.","$ref":"#/components/schemas/CurrencyAmount"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/StatementResponseEntry"}},"count":{"type":"integer","format":"int32","description":"The total number of entries matching the filter criteria."},"responseCount":{"type":"integer","format":"int32","description":"The number of entries returned in this response."},"footer":{"type":"string","description":"Regulatory and card scheme footer text for the statement."}}}},"components/schemas/InstrumentTransactionActivityList":{"id":"components/schemas/InstrumentTransactionActivityList","kind":"json-schema","title":"InstrumentTransactionActivityList","data":{"type":"object","description":"A paginated list of transaction activity entries scoped to a single instrument.","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/InstrumentTransactionActivityItem"}},"count":{"type":"integer","format":"int64","description":"The total number of records matching the filter criteria."},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/InstrumentTransactionActivityItem":{"id":"components/schemas/InstrumentTransactionActivityItem","kind":"json-schema","title":"InstrumentTransactionActivityItem","data":{"type":"object","required":["id","type","status","amount","creationTimestamp"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction activity entry returned by the per-instrument transactions endpoints"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/managed_accounts/{id}/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted because it is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already known from the path parameter."},"children":[]}]}]}],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The transaction identifier."},"type":{"$ref":"#/components/schemas/TransactionActivityType"},"status":{"$ref":"#/components/schemas/TransactionActivityStatus"},"direction":{"$ref":"#/components/schemas/TransactionActivityDirection"},"amount":{"description":"The primary transaction amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"fee":{"description":"The fee linked to this transaction, if any.","$ref":"#/components/schemas/FeeSummary"},"creationTimestamp":{"type":"integer","format":"int64"},"lastUpdatedTimestamp":{"type":"integer","format":"int64"},"transaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full transaction object. Schema matches the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/Transfer"},{"$ref":"#/components/schemas/Send"},{"$ref":"#/components/schemas/OutgoingWireTransfer"},{"$ref":"#/components/schemas/CorrespondentBankingOwt"},{"$ref":"#/components/schemas/IncomingWireTransfer"},{"$ref":"#/components/schemas/CardPayment"},{"$ref":"#/components/schemas/FeeTransaction"},{"$ref":"#/components/schemas/SystemTransaction"}]}}}},"components/schemas/ManagedCard":{"id":"components/schemas/ManagedCard","kind":"json-schema","title":"ManagedCard","data":{"required":["externalHandle","cardBrand","cardLevelClassification","creationTimestamp","currency","expiryPeriodMonths","friendlyName","id","nameOnCard","profileId","renewalType","type","mode","state","cardNumberFirstSix","cardNumberLastFour","startMmyy","expiryMmyy","billingAddress","digitalWallets"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the card."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"externalHandle":{"type":"string","description":"A uniquely generated code used to identify a card.\n\nThis code is to be used instead of the sensitive card number in order to refer to a card when opening a support ticket.\n"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"maxLength":50,"minLength":1,"type":"string","description":"The friendly name given to the card."},"currency":{"$ref":"#/components/schemas/Currency"},"state":{"$ref":"#/components/schemas/ManagedInstrumentState"},"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 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":"text","inline":true,"attributes":{"content":"VIRTUAL: Not a printed or embedded card. The card can be used online or added to digital wallets."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHYSICAL: A physical card that can be printed and shipped to your customers or embedded in a Wearable device. It can be used at physical terminals."},"children":[]}]}]}]}],"enum":["VIRTUAL","PHYSICAL"]},"cardBrand":{"type":"string","description":"The card scheme, or brand of the card.","enum":["MASTERCARD","VISA"]},"cardNumber":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full card number of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is omitted when the card state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/SensitiveCardNumber"},"cvv":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The CVV of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is omitted when the card state is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/SensitiveCvv"},"cardNumberFirstSix":{"pattern":"^[0-9]{6}$","type":"string","description":"The first six digits of the card number."},"cardNumberLastFour":{"pattern":"^[0-9]{4}$","type":"string","description":"The last four digits of the card number."},"nameOnCard":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card holder’s name for the card. This may be verified by merchants when the card is used online. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards."},"children":[]}]}]}]},"nameOnCardLine2":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards."},"startMmyy":{"maxLength":4,"minLength":4,"pattern":"^[0-9]*$","type":"string","description":"The start date of this card, in MMYY format."},"expiryMmyy":{"maxLength":4,"minLength":4,"type":"string","description":"The end date of this card, in MMYY format."},"cardLevelClassification":{"type":"string","enum":["CONSUMER","CORPORATE"],"description":"The card classification determines whether the card is from Consumer or Corporate BINs."},"expiryPeriodMonths":{"maximum":120,"minimum":1,"type":"integer","format":"int32","description":"The validity timeframe of the card, in months."},"renewalType":{"$ref":"#/components/schemas/CardRenewalType"},"renewalTimestamp":{"type":"integer","format":"int64","description":"The timestamp when the card will be renewed, expressed in Epoch timestamp using millisecond precision."},"creationTimestamp":{"type":"integer","format":"int64","description":"The timestamp when the card was created, expressed in Epoch timestamp using millisecond precision."},"cardholderMobileNumber":{"description":"The mobile number including country code of the card holder, needed for 3DS challenge.","maxLength":15,"minLength":5,"pattern":"^\\+[0-9]+$","type":"string","deprecated":true},"billingAddress":{"description":"The billing address set for the cardholder. This can be checked by the merchant during online purchases.","$ref":"#/components/schemas/BillingAddress"},"physicalCardDetails":{"$ref":"#/components/schemas/PhysicalCardDetails"},"digitalWallets":{"$ref":"#/components/schemas/DigitalWallets"},"authForwardingDefaultTimeoutDecision":{"type":"string","description":"Default decision for auth forwarding on timeout","enum":["APPROVE","DECLINE"]},"threeDSecureAuthConfig":{"$ref":"#/components/schemas/ThreeDSecureAuthConfig"},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode with which this card was created:"},"children":[]}]}]},{"$$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 prepaid mode card has its own balance and can have funds transferred to or from it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A debit mode card does not have its own balance but will be able to spend funds belonging to its parent managed account, subject to a configurable spend limit."},"children":[]}]}]}]}]},"externalData":{"$ref":"#/components/schemas/ExternalData"},"userId":{"$ref":"#/components/schemas/UserId","description":"The Authorised User to be linked to the card, whose authentication details will be used for actions such as 3DS authentication, or manual provisioning to a digital wallet. This field can be used instead of threeDSecureAuthConfig as it better describes the wider scope of possible uses."},"singleSpend":{"type":"boolean","description":"Indicates if the card is configured for single-spend mode. When true, the card will be automatically blocked after the first successful transaction."},"replacement":{"$ref":"#/components/schemas/ManagedCardReplacement"}},"discriminator":{"propertyName":"mode","mapping":{"PREPAID_MODE":"#/components/schemas/PrepaidModeCard","DEBIT_MODE":"#/components/schemas/DebitModeCard"}}}},"components/schemas/CardPaymentList":{"id":"components/schemas/CardPaymentList","kind":"json-schema","title":"CardPaymentList","data":{"type":"object","description":"Paginated list of CardPayments.","properties":{"cardPayments":{"type":"array","items":{"$ref":"#/components/schemas/CardPayment"}},"count":{"type":"integer","format":"int64"},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/CardPayment":{"id":"components/schemas/CardPayment","kind":"json-schema","title":"CardPayment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One card transaction's full lifecycle — authorisation, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designed for two audiences:"},"children":[]}]}]},{"$$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":"Building UI?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Read the top-level summary fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"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":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). They are platform-maintained — show them as-is. No need to understand auth-vs-clearing, reversals, or scheme messages. The debit/credit direction is implicit from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchases / cash withdrawals / account funding debit the card; refunds / original credits credit it). For the issuer authorisation code, walk "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — every event in the lifecycle carries it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need scheme-level detail?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Walk "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full per-step audit trail — every authorisation, clearing, reversal, and refund step — with original scheme amounts (merchant + card currency, with exchange rates), reason codes, and fees attached to the event that triggered them."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each card payment corresponds to one card-scheme lifecycle (Visa Transaction Identifier / Mastercard TLID). Related-but-separate transactions (refunds, tips, recurring follow-ups) are separate card payments linked via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedCardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (direct parent)."},"children":[]}]}]}],"required":["id","type","card","merchant","displayAmount","status","events","creationTimestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Stable identifier across the entire payment lifecycle."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The high-level type of card payment. For finer-grained classification (e.g. distinguishing a sale-purchase from a sale with cashback), see the per-event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subtype"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentType"},"card":{"description":"The managed card used for this payment.","$ref":"#/components/schemas/Card"},"merchant":{"$ref":"#/components/schemas/Merchant"},"displayAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform-maintained headline amount of the card payment, in the cardholder's preferred display currency (which matches the card billing currency unless a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set when the card was created). The amount is derived from card payment events and can be displayed in your transaction activity UI as the amount of the card payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a headline amount, it reflects the intended amount of the 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":"In the case of a full reversal or cancellation and within-lifecycle dispute swings it stays stable. For example, an auth-50 → settle-50 → reverse-50 cycle still reads as 50 here, even though the net ledger impact is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of a partial reversal it reflects the net amount, so the display amount of the card payment reflects the revised amount. For example, an auth-50 (displayAmount 50) → settle-40 with a release of the remaining auth of 10, displayAmount updated to 40."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To compute the actual net (for accounting), sum the amounts of your chosen type, from all the events, yourself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Magnitude is always positive. The debit/credit direction is implicit from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchases debit, refunds and OCTs credit). For the lifecycle phase, read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For amounts in the merchant's currency (transaction currency) or the card's currency (if different from your preferred currency), read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"status":{"$ref":"#/components/schemas/CardPaymentStatus"},"relatedCardPaymentId":{"type":"string","pattern":"^[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct parent linkage — id of the single prior card payment that this payment derives from. Set on:"},"children":[]}]}]},{"$$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":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments referring to the original purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments referring to the prior purchase being credited"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip / add-on payments referring to the original ride / fare / service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment / recurring payments referring to the initial setup transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponds to Visa's \"Original Transaction ID\" linkage and Mastercard's DE 105 subelement 002 (Economically Related Transaction Identifier). Not used for messages that share a single lifecycle — those are events on the same card payment."},"children":[]}]}]}]},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered event stream — every scheme message in this card payment's lifecycle. For headline display use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; walk this when you need scheme-level detail (per-event amounts, fees, reason codes, reversals)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CardPaymentEvent"}},"creationTimestamp":{"type":"integer","format":"int64","description":"When the first event for this payment was received, Epoch millis."},"lastUpdatedTimestamp":{"type":"integer","format":"int64","description":"When the most recent event for this payment was received, Epoch millis."}}}},"components/schemas/CardPaymentEventList":{"id":"components/schemas/CardPaymentEventList","kind":"json-schema","title":"CardPaymentEventList","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentEventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentEventDetail"}},"count":{"type":"integer","format":"int64"},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/AllLevelSpendRules":{"id":"components/schemas/AllLevelSpendRules","kind":"json-schema","title":"AllLevelSpendRules","data":{"type":"object","properties":{"allowedMerchantCategories":{"deprecated":true,"type":"array","maxItems":200,"items":{"type":"string"},"description":"Whitelist MCC: A list of allowed merchant category codes (MCCs). If the MCC does not match, then the transaction will be declined. If an MCC is also in the blocked list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"allowedMerchantCategories\" instead."},"blockedMerchantCategories":{"deprecated":true,"type":"array","maxItems":200,"items":{"type":"string"},"description":"Blacklist MCC: A list of disallowed merchant category codes (MCCs). If the MCC matches, then the transaction will be declined. If an MCC is also in the allowed list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"blockedMerchantCategories\" instead."},"allowedMerchantIds":{"deprecated":true,"type":"array","maxItems":200,"items":{"type":"string"},"description":"Whitelist Merchant Id: A list of allowed merchant IDs. If the Merchant Id does not match, then the transaction will be declined. If a Merchant Id is also provided in the blocked list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"allowedMerchantIds\" instead."},"blockedMerchantIds":{"deprecated":true,"type":"array","maxItems":200,"items":{"type":"string"},"description":"Blacklist Merchant Id: A list of disallowed merchant IDs. If the Merchant Id matches, then the transaction will be declined. If a Merchant Id is also in the allowed list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"blockedMerchantIds\" instead."},"allowedMerchantCountries":{"deprecated":true,"type":"array","maxItems":50,"items":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"description":"Whitelist Merchant Country: A list of allowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country does not match, then the transaction will be declined. If a Merchant Country is also provided in the blocked list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"allowedMerchantCountries\" instead."},"blockedMerchantCountries":{"deprecated":true,"type":"array","maxItems":50,"items":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"description":"Blacklist Merchant Country: A list of disallowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country matches, then the transaction will be declined. If a Merchant Country is also in the allowed list, the blocked list will take precedence. This field is deprecated - use \"cardLevelSpendRules\".\"blockedMerchantCountries\" instead."},"allowContactless":{"deprecated":true,"type":"boolean","description":"Indicates if a contactless transaction is allowed on the card. This field is deprecated - use \"cardLevelSpendRules\".\"allowContactless\" instead."},"allowAtm":{"deprecated":true,"type":"boolean","description":"Indicates if an ATM Withdrawal transaction is allowed on the card. This field is deprecated - use \"cardLevelSpendRules\".\"allowAtm\" instead."},"allowECommerce":{"deprecated":true,"type":"boolean","description":"Indicates if an online transaction is allowed on the card. This field is deprecated - use \"cardLevelSpendRules\".\"allowECommerce\" instead."},"allowCashback":{"deprecated":true,"type":"boolean","description":"Indicates if a cashback transaction at a physical terminal is allowed on the card. This field is deprecated - use \"cardLevelSpendRules\".\"allowCashback\" instead."},"allowCreditAuthorisations":{"deprecated":true,"type":"boolean","description":"Indicates if a the card can receive a credit transaction. This field is deprecated - use \"cardLevelSpendRules\".\"allowCashback\" instead."},"minTransactionAmount":{"deprecated":true,"type":"integer","minimum":0,"format":"int64","description":"The minimum transaction amount, in card currency, that is allowed. If the transaction amount is less than this value, then the transaction will be declined. Omit this, or set to 0 if no maximum transaction amount is to be set. This field is deprecated - use \"cardLevelSpendRules\".\"minTransactionAmount\" instead."},"maxTransactionAmount":{"deprecated":true,"type":"integer","minimum":0,"format":"int64","description":"The maximum transaction amount, in card currency, that is allowed. If the transaction amount is greater than this value, then the transaction will be declined. Omit this, or set to 0 if no maximum transaction amount is to be set. This field is deprecated - use \"cardLevelSpendRules\".\"maxTransactionAmount\" instead."},"spendLimit":{"deprecated":true,"description":"The total amount of funds that can be spent using this card, in a given time interval. This field is deprecated - use \"cardLevelSpendRules\".\"spendLimit\" instead.","type":"array","items":{"$ref":"#/components/schemas/SpendLimit"}},"cardLevelSpendRules":{"$ref":"#/components/schemas/CardLevelSpendRules"},"profileLevelSpendRules":{"$ref":"#/components/schemas/ProfileLevelSpendRules"},"identityLevelSpendRules":{"$ref":"#/components/schemas/IdentityLevelSpendRules"}}}},"components/schemas/Transfer":{"id":"components/schemas/Transfer","kind":"json-schema","title":"Transfer","data":{"required":["id","profileId","creationTimestamp","destination","destinationAmount","source","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of a Transfer transaction."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"source":{"description":"The source managed account or card from where the funds were transferred.","$ref":"#/components/schemas/InstrumentId"},"destination":{"description":"The destination managed account or card to where the funds were transferred.","$ref":"#/components/schemas/InstrumentId"},"destinationAmount":{"description":"The amount, in same currency as source and destination, that was transferred from the source to the destination instrument.","$ref":"#/components/schemas/CurrencyAmount"},"description":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":"The description details that are included in the transaction as reference."},"state":{"$ref":"#/components/schemas/TransactionState"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the transaction was created, expressed in Epoch timestamp using millisecond precision."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"}}}},"components/schemas/TransactionBulkCancelResponse":{"id":"components/schemas/TransactionBulkCancelResponse","kind":"json-schema","title":"TransactionBulkCancelResponse","data":{"required":["cancellations"],"type":"object","properties":{"cancellations":{"type":"array","description":"Contains the cancellation details for each of the transactions.","items":{"$ref":"#/components/schemas/TransactionCancelResponse"}}}}},"components/schemas/Send":{"id":"components/schemas/Send","kind":"json-schema","title":"Send","data":{"required":["id","profileId","creationTimestamp","source","destinationAmount","state","transactionAmount"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of a send transaction."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"source":{"description":"The source managed account or card from where the funds were sent.","$ref":"#/components/schemas/InstrumentId"},"sourceFee":{"allOf":[{"$ref":"#/components/schemas/CurrencyAmount"},{"type":"object","description":"The fee applied to the source."}]},"destination":{"description":"The destination managed account or card to where the funds were sent.","oneOf":[{"$ref":"#/components/schemas/InstrumentId"},{"$ref":"#/components/schemas/BeneficiaryId"}]},"destinationAmount":{"description":"The amount, in same currency as source and destination, that was sent from the source to the destination instrument.","$ref":"#/components/schemas/CurrencyAmount"},"destinationFee":{"allOf":[{"$ref":"#/components/schemas/CurrencyAmount"},{"type":"object","description":"The fee applied to the destination."}]},"transactionAmount":{"allOf":[{"$ref":"#/components/schemas/CurrencyAmount"},{"type":"object","description":"The original transaction amount before any fees were deducted."}]},"description":{"type":"string","description":"The description details that are passed to the beneficiary.","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"state":{"$ref":"#/components/schemas/SendState"},"challengeExemptionReason":{"$ref":"#/components/schemas/ChallengeExemptionReason"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the transaction was created, expressed in Epoch timestamp using millisecond precision."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"}}}},"components/schemas/IncomingWireTransferList":{"id":"components/schemas/IncomingWireTransferList","kind":"json-schema","title":"IncomingWireTransferList","data":{"type":"object","description":"A paginated list of incoming wire transfers.","properties":{"incomingWireTransfers":{"type":"array","items":{"$ref":"#/components/schemas/IncomingWireTransfer"}},"count":{"type":"integer","format":"int64"},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/IncomingWireTransfer":{"id":"components/schemas/IncomingWireTransfer","kind":"json-schema","title":"IncomingWireTransfer","data":{"type":"object","required":["id","state","amount","destinationInstrument","createdAt"],"description":"An incoming wire transfer received from an external bank account.","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the incoming wire transfer."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"state":{"$ref":"#/components/schemas/IncomingWireTransferMultiState"},"amount":{"description":"The amount credited (or to be credited) to the destination instrument, in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"fee":{"description":"The fee charged on this incoming wire transfer. Omitted when no fee was charged.","$ref":"#/components/schemas/CurrencyAmount"},"destinationInstrument":{"description":"The managed account (with IBAN) that received the funds.","$ref":"#/components/schemas/InstrumentId"},"paymentNetwork":{"type":"string","enum":["SEPA","FASTER_PAYMENTS","SWIFT","RIX","BACS","CHAPS","TARGET"],"description":"The payment network over which the transfer was received."},"senderName":{"type":"string","description":"The name of the sender."},"senderIban":{"type":"string","description":"The IBAN of the sender."},"senderReference":{"type":"string","description":"The payment reference provided by the sender."},"forex":{"$ref":"#/components/schemas/TransactionForex"},"isInstant":{"type":"boolean","description":"Whether this was an instant payment."},"createdAt":{"type":"integer","format":"int64","description":"When the IWT was received, expressed in Epoch timestamp using millisecond precision."},"executedAt":{"type":"integer","format":"int64","description":"When the IWT was settled, expressed in Epoch timestamp using millisecond precision."}}}},"components/schemas/OutgoingWireTransfer":{"id":"components/schemas/OutgoingWireTransfer","kind":"json-schema","title":"OutgoingWireTransfer","data":{"required":["id","profileId","creationTimestamp","sourceInstrument","transferAmount","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of an Outgoing Wire Transfer transaction."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"sourceInstrument":{"required":["type","id"],"type":"object","description":"The source managed account from where the funds were taken.","properties":{"type":{"type":"string","enum":["managed_accounts"]},"id":{"type":"string","pattern":"^[0-9]+$"}}},"transferAmount":{"description":"The amount, in same currency as source and destination, that was transferred from the source.","$ref":"#/components/schemas/CurrencyAmount"},"fee":{"description":"The fee charged on this outgoing wire transfer. Omitted when no fee was charged.","$ref":"#/components/schemas/CurrencyAmount"},"purpose":{"type":"string","maxLength":255,"description":"The purpose of the payment."},"description":{"maxLength":50,"type":"string","description":" Transaction description."},"type":{"$ref":"#/components/schemas/OutgoingWireTransferType"},"destination":{"oneOf":[{"$ref":"#/components/schemas/OutgoingWireTransferBeneficiary"},{"$ref":"#/components/schemas/SEPABeneficiary"},{"$ref":"#/components/schemas/SWIFTBeneficiary"},{"$ref":"#/components/schemas/RIXBeneficiary"},{"$ref":"#/components/schemas/FasterPaymentsBeneficiary"},{"$ref":"#/components/schemas/BeneficiaryId"},{"$ref":"#/components/schemas/ExternalAccountId"}]},"state":{"$ref":"#/components/schemas/OutgoingWireTransferState"},"rejectedInfo":{"$ref":"#/components/schemas/OutgoingWireTransferRejectedInfo"},"challengeExemptionReason":{"$ref":"#/components/schemas/ChallengeExemptionReason"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the transaction was created, expressed in Epoch timestamp using millisecond precision."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"validationOutcomes":{"type":"array","items":{"$ref":"#/components/schemas/OutgoingWireTransferValidationOutcome"}}}}},"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict":{"id":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflict","kind":"json-schema","title":"OutgoingWireTransferUpdateBeneficiaryNameConflict","data":{"type":"object","properties":{"errorCode":{"$ref":"#/components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode"}}}},"components/schemas/OutgoingWireTransferPaymentConfirmationConflict":{"id":"components/schemas/OutgoingWireTransferPaymentConfirmationConflict","kind":"json-schema","title":"OutgoingWireTransferPaymentConfirmationConflict","data":{"type":"object","required":["errorCode"],"properties":{"errorCode":{"$ref":"#/components/schemas/OutgoingWireTransferPaymentConfirmationConflictErrorCode"}}}},"components/schemas/CorrespondentBankingOwt":{"id":"components/schemas/CorrespondentBankingOwt","kind":"json-schema","title":"CorrespondentBankingOwt","data":{"required":["id","profileId","creationTimestamp","sourceInstrument","amount","originator","beneficiary","purpose","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the Correspondent Banking OWT."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"sourceInstrument":{"required":["type","id"],"type":"object","description":"The source managed account from where the funds were taken.","properties":{"type":{"type":"string","enum":["managed_accounts"]},"id":{"type":"string","pattern":"^[0-9]+$"}}},"amount":{"description":"The amount transferred.","$ref":"#/components/schemas/CurrencyAmount"},"originator":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingIndividualOriginator"},{"$ref":"#/components/schemas/CorrespondentBankingBusinessOriginator"}]},"beneficiary":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingSEPABeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingRIXBeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingFasterPaymentsBeneficiary"}]},"purpose":{"type":"string","maxLength":255,"description":"The purpose of the payment."},"description":{"maxLength":35,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details are passed to the beneficiary as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is mandatory for wire transfers executed over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The allowed length is dependent on the payment type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters. An extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]}]},"externalData":{"type":"array","description":"Additional external data as key-value pairs.","items":{"$ref":"#/components/schemas/CorrespondentBankingExternalData"}},"state":{"$ref":"#/components/schemas/CorrespondentBankingOwtState"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the transaction was created, expressed in Epoch timestamp using millisecond precision."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"validationOutcomes":{"type":"array","items":{"$ref":"#/components/schemas/CorrespondentBankingOwtValidationOutcome"}}}}},"components/schemas/BeneficiaryBatch":{"id":"components/schemas/BeneficiaryBatch","kind":"json-schema","title":"BeneficiaryBatch","data":{"type":"object","required":["operationBatchId","state"],"properties":{"operationBatchId":{"$ref":"#/components/schemas/BeneficiaryOperationBatchId"},"tag":{"$ref":"#/components/schemas/Tag"},"state":{"$ref":"#/components/schemas/BeneficiaryBatchState"}}}},"components/schemas/Beneficiary":{"id":"components/schemas/Beneficiary","kind":"json-schema","title":"Beneficiary","data":{"allOf":[{"$ref":"#/components/schemas/BasicBeneficiary"},{"type":"object","required":["id","relatedOperationBatches","state"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of a Beneficiary."},"relatedOperationBatches":{"description":"The object representing the list of batch IDs and the operations that occurred for each batch.","type":"array","items":{"$ref":"#/components/schemas/BeneficiaryOperationBatchId"}},"state":{"$ref":"#/components/schemas/BeneficiaryState"},"validationFailure":{"$ref":"#/components/schemas/BeneficiaryValidationFailure"}}}]}},"components/schemas/TransactionActivityList":{"id":"components/schemas/TransactionActivityList","kind":"json-schema","title":"TransactionActivityList","data":{"type":"object","description":"A paginated list of transaction activity entries.","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/TransactionActivityItem"}},"count":{"type":"integer","format":"int64","description":"The total number of records matching the filter criteria."},"responseCount":{"type":"integer","format":"int64"}}}},"components/schemas/SCAOtpChannel":{"id":"components/schemas/SCAOtpChannel","kind":"json-schema","title":"SCAOtpChannel","data":{"type":"string","enum":["SMS"],"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":"text","inline":true,"attributes":{"content":"\"SMS\": The one-time-password is sent as a text message"},"children":[]}]}]}]}]}},"components/schemas/SCAPushChannel":{"id":"components/schemas/SCAPushChannel","kind":"json-schema","title":"SCAPushChannel","data":{"type":"string","enum":["AUTHY","BIOMETRIC"],"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":"text","inline":true,"attributes":{"content":"\"AUTHY\": The push notification is sent on the user's device using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.twilio.com/authy"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twilio Authy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"BIOMETRIC\": The push notification is sent to the user's device"},"children":[]}]}]}]}]}},"components/schemas/AuthSCAPushChannel":{"id":"components/schemas/AuthSCAPushChannel","kind":"json-schema","title":"AuthSCAPushChannel","data":{"type":"string","enum":["AUTHY"],"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":"text","inline":true,"attributes":{"content":"\"AUTHY\": The push notification is sent on the user's device using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.twilio.com/authy"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Twilio Authy"},"children":[]}]}]}]}]}]}},"components/schemas/BulkProcessStatus":{"id":"components/schemas/BulkProcessStatus","kind":"json-schema","title":"BulkProcessStatus","data":{"type":"string","enum":["SUBMITTED","RUNNING","PARTIALLY_COMPLETED","COMPLETED","FAILED","PAUSED","CANCELLED"]}},"components/schemas/BulkId":{"id":"components/schemas/BulkId","kind":"json-schema","title":"BulkId","data":{"type":"string","pattern":"^[0-9]+$"}},"components/schemas/BulkProcessOperationStatus":{"id":"components/schemas/BulkProcessOperationStatus","kind":"json-schema","title":"BulkProcessOperationStatus","data":{"type":"string","enum":["SUBMITTED","RUNNING","COMPLETED","FAILED","CANCELLED"]}},"components/schemas/InstrumentState":{"id":"components/schemas/InstrumentState","kind":"json-schema","title":"InstrumentState","data":{"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 instrument indicating what it can and cannot do 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":"text","inline":true,"attributes":{"content":"ACTIVE: The instrument is in an active state and can be used in transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESTROYED: The instrument has been permanently destroyed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destroyReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was destroyed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps."},"children":[]}]}]}]}],"enum":["ACTIVE","BLOCKED","DESTROYED","NOT_ENABLED"]}},"components/schemas/LinkedAccountVerificationRunState":{"id":"components/schemas/LinkedAccountVerificationRunState","kind":"json-schema","title":"LinkedAccountVerificationRunState","data":{"type":"string","enum":["PENDING","VERIFIED","REJECTED"]}},"components/schemas/BlockedReason":{"id":"components/schemas/BlockedReason","kind":"json-schema","title":"BlockedReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the instrument has been blocked:"},"children":[]}]}]},{"$$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":"USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST: The instrument has been blocked because it was marked as lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_SPEND: The instrument has been automatically blocked after its first successful transaction (single-spend card)."},"children":[]}]}]}]}],"enum":["USER","SYSTEM","LOST","SINGLE_SPEND"]}},"components/schemas/DestroyedReason":{"id":"components/schemas/DestroyedReason","kind":"json-schema","title":"DestroyedReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the instrument has been destroyed:"},"children":[]}]}]},{"$$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":"SYSTEM: The platform or an administrator of the platform has destroyed the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST: The instrument was automatically destroyed as it was marked as lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOLEN: The instrument was automatically destroyed as it was marked as stolen."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: The instrument was automatically destroyed as it expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPROMISED: The instrument was automatically destroyed as it was marked as compromised."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_SPEND: The instrument was automatically destroyed as it was a single-spend card that was used."},"children":[]}]}]}]}],"enum":["SYSTEM","USER","LOST","STOLEN","EXPIRED","COMPROMISED","SINGLE_SPEND"]}},"components/schemas/StatementTransactionType":{"id":"components/schemas/StatementTransactionType","kind":"json-schema","title":"StatementTransactionType","data":{"type":"string","enum":["AUTHORISATION","SETTLEMENT","MANUAL_TRANSACTION","TRANSFER","SEND","DEPOSIT","AUTHORISATION_REVERSAL","AUTHORISATION_EXPIRY","AUTHORISATION_DECLINE","AUTHORISATION_MANUAL_CLOSE","MERCHANT_REFUND","MERCHANT_REFUND_REVERSAL","ORIGINAL_CREDIT_TRANSACTION","SETTLEMENT_REVERSAL","ADJUSTMENT","CHARGE_FEE","WITHDRAWAL_RESERVE","WITHDRAWAL_RELEASE","FEE_REVERSAL","OUTGOING_WIRE_TRANSFER","AUTHORISATION_CANCELLATION","SYSTEM_TRANSACTION","OUTGOING_DIRECT_DEBIT_COLLECTION","OUTGOING_DIRECT_DEBIT_REFUND","CORRESPONDENT_BANK_TRANSFER"]}},"components/schemas/InstrumentStatementSortOrder":{"id":"components/schemas/InstrumentStatementSortOrder","kind":"json-schema","title":"InstrumentStatementSortOrder","data":{"type":"string","enum":["ASC","DESC"]}},"components/schemas/StatementResponseEntryTransactionType":{"id":"components/schemas/StatementResponseEntryTransactionType","kind":"json-schema","title":"StatementResponseEntryTransactionType","data":{"type":"string","description":"The top-level type of transaction represented by this statement entry.","enum":["card_payments","transfers","sends","outgoing_wire_transfers","incoming_wire_transfers","correspondent_bank_transfers","fees","system_transactions"]}},"components/schemas/AccessInstrumentType":{"id":"components/schemas/AccessInstrumentType","kind":"json-schema","title":"AccessInstrumentType","data":{"type":"string","description":"The type of access instrument that initiated a transaction.","enum":["managed_cards","ibans"]}},"components/schemas/TransactionActivityType":{"id":"components/schemas/TransactionActivityType","kind":"json-schema","title":"TransactionActivityType","data":{"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:"},"children":[]}]}]},{"$$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":"transfers: Internal transfer between instruments of the same identity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sends: Transfer between instruments of different identities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outgoing_wire_transfers: Wire transfer to an external bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"correspondent_bank_transfers: Wire transfer on behalf of a third-party originator"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incoming_wire_transfers: Wire transfer received from an external bank account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card_payments: Card payment (purchase, refund, OCT, etc.) with full lifecycle"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fees: Fee charged or reversed on an instrument"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system_transactions: System-generated transactions (balance adjustments, account closures, dispute outcomes, etc.)"},"children":[]}]}]}]}],"enum":["transfers","sends","outgoing_wire_transfers","correspondent_bank_transfers","incoming_wire_transfers","card_payments","fees","system_transactions"]}},"components/schemas/TransactionActivityStatus":{"id":"components/schemas/TransactionActivityStatus","kind":"json-schema","title":"TransactionActivityStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normalised lifecycle status of a 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":"DRAFT: Transaction ID has been created. There are additional user-actions required before the transaction is considered an “executable instruction” that is fully submitted. No balance movements have taken place on the target instrument yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED: Transaction has been submitted and is awaiting processing. No balance movements have taken place yet. Transactions scheduled for processing on a future date remain in a submitted status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING: The submitted transaction is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: Executed and processed. Funds have moved, actual balance changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: Transaction was cancelled before completion. Funds have been returned to the original instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The transaction was previously COMPLETED but has been returned. Funds have been returned to the original instrument. Note that card refunds may be separate transactions, not RETURNED purchases."},"children":[]}]}]}]}],"enum":["DRAFT","SUBMITTED","PROCESSING","COMPLETED","CANCELLED","RETURNED"]}},"components/schemas/TransactionActivityDirection":{"id":"components/schemas/TransactionActivityDirection","kind":"json-schema","title":"TransactionActivityDirection","data":{"type":"string","description":"Whether funds were credited to or debited from the instrument.","enum":["CREDIT","DEBIT"]}},"components/schemas/TransactionActivitySortBy":{"id":"components/schemas/TransactionActivitySortBy","kind":"json-schema","title":"TransactionActivitySortBy","data":{"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 to sort transaction activity results by:"},"children":[]}]}]},{"$$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":"creationTimestamp: Sort by when the transaction was first created (default)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lastUpdatedTimestamp: Sort by when the transaction was most recently updated."},"children":[]}]}]}]}],"enum":["creationTimestamp","lastUpdatedTimestamp"]}},"components/schemas/CardPaymentStatus":{"id":"components/schemas/CardPaymentStatus","kind":"json-schema","title":"CardPaymentStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of a CardPayment."},"children":[]}]}]},{"$$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":"SETTLEMENT_IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — authorised, not yet (or not fully) settled. The hold is still on the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — terminal; nothing further is expected. The customer has been charged, except for a zero-amount card check, which settles on arrival without a charge."},"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 latest authorisation was declined; no money moved."},"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 authorisation was cancelled/reversed before settlement; no charge applied."},"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":" — the authorisation timed out without settling."},"children":[]}]}]}]}],"enum":["SETTLEMENT_IN_PROGRESS","SETTLED","DECLINED","CANCELLED","EXPIRED"]}},"components/schemas/CardPaymentType":{"id":"components/schemas/CardPaymentType","kind":"json-schema","title":"CardPaymentType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-level type of card payment, derived from the first event."},"children":[]}]}]},{"$$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":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — standard purchase at a merchant. A purchase of zero is the check a merchant runs to prove the card is live before storing it on file: no money moves, no hold is placed, and it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on arrival since nothing further will follow. If the merchant later charges the same purchase, the card payment adopts the real type and amount."},"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":" — refund from a merchant to the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — push credit to the cardholder (OCT)."},"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":" — load funds onto an account."},"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":" — cash withdrawn at ATM or scheme cash service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE_INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — non-financial balance check."},"children":[]}]}]}]}],"enum":["PURCHASE","REFUND","ORIGINAL_CREDIT","ACCOUNT_FUNDING","CASH_WITHDRAWAL","BALANCE_INQUIRY"]}},"components/schemas/CardPaymentSubtype":{"id":"components/schemas/CardPaymentSubtype","kind":"json-schema","title":"CardPaymentSubtype","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheme-network subtype that further classifies an event. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on each event."},"children":[]}]}]}],"enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","account_funding","purchase_reversals","cash_withdrawal_reversals","purchase_refunds","purchase_refund_reversals","original_credit_transactions","original_credit_transaction_reversals"]}},"components/schemas/CardPaymentEventType":{"id":"components/schemas/CardPaymentEventType","kind":"json-schema","title":"CardPaymentEventType","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 event recorded against a CardPayment. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag on each event distinguishes a reversal from the original action."},"children":[]}]}]}],"enum":["AUTHORISATION","SETTLEMENT","REFUND","ORIGINAL_CREDIT"]}},"components/schemas/TransactionState":{"id":"components/schemas/TransactionState","kind":"json-schema","title":"TransactionState","data":{"type":"string","description":"Status of the transaction.","enum":["INITIALISED","COMPLETED","REJECTED","FAILED","PENDING","SCHEDULED","CANCELLED"]}},"components/schemas/InstrumentType":{"id":"components/schemas/InstrumentType","kind":"json-schema","title":"InstrumentType","data":{"type":"string","enum":["managed_cards","managed_accounts"]}},"components/schemas/SendState":{"id":"components/schemas/SendState","kind":"json-schema","title":"SendState","data":{"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 send transaction, 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":"text","inline":true,"attributes":{"content":"INVALID: The send transaction has failed initial validation checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INITIALISED: The initial state of a send transaction when SCA is not required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING: The send transaction has exceeded the destination limit and is pending treasury approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The send transaction that was submitted has been approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The requested funds have been sent from the source instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The send transaction that was submitted was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the send transaction, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The send transaction has been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The send transaction will be executed at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled send transaction has been cancelled."},"children":[]}]}]}]}],"enum":["INVALID","INITIALISED","COMPLETED","REJECTED","FAILED","PENDING","PENDING_CHALLENGE","APPROVED","RETURNED","SCHEDULED","CANCELLED"]}},"components/schemas/IncomingWireTransferMultiState":{"id":"components/schemas/IncomingWireTransferMultiState","kind":"json-schema","title":"IncomingWireTransferMultiState","data":{"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 an incoming wire transfer:"},"children":[]}]}]},{"$$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":"PENDING: The transfer has been received and is being processed. Funds have not yet been credited to the destination account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: Funds have been credited to the destination account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The transfer was not accepted; funds were not credited."},"children":[]}]}]}]}],"enum":["PENDING","COMPLETED","REJECTED"]}},"components/schemas/OutgoingWireTransferState":{"id":"components/schemas/OutgoingWireTransferState","kind":"json-schema","title":"OutgoingWireTransferState","data":{"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 Outgoing wire transfer transaction, 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":"text","inline":true,"attributes":{"content":"INVALID: The wire transfer has failed initial validation checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED: The wire transfer has been submitted to the sending financial institution for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The wire transfer that was submitted was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the wire transfer, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The requested funds have been sent from the source instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The wire transfer has been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The wire transfer will be executed at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled wire transfer has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding."},"children":[]}]}]}]}],"type":"string","enum":["INVALID","PENDING_CHALLENGE","SUBMITTED","REJECTED","APPROVED","FAILED","COMPLETED","RETURNED","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/BulkProcess":{"id":"components/schemas/BulkProcess","kind":"json-schema","title":"BulkProcess","data":{"type":"object","properties":{"bulkId":{"description":"The bulk id of the bulk process","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"SUBMITTED\": the data for the bulk process operations has been persisted and bulk process is ready for execution. A bulk process in this status can be executed or submitted. This is the initial state for a bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"RUNNING\" :  the bulk process is currently being executed by the system"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"COMPLETED\"  : the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully. This is a final state for the bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"PARTIALLY_COMPLETED\"  the execution of the bulk process is complete and some of the bulk operations of the bulk process failed. This is a final state for the bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"FAILED\" : none of the operations of the bulk process have executed. This is a final state for the bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"PAUSED\"  : the execution of bulk process has been paused through the Pause bulk process operation  Execution can be resumed through Resume bulk operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"CANCELLED\" : the execution of bulk process has been cancelled through Cancel bulk operation. This is a final state for the bulk process"},"children":[]}]}]}],"type":"string"},"submittedItemsCount":{"description":"The number of bulk operations in the bulk process","type":"integer"},"executionStart":{"description":"Timestamp of when the execution of the Bulk Process started","type":"integer","format":"int64"},"executionFinish":{"description":"Timestamp of when the execution of the Bulk Process finished.","type":"integer","format":"int64"},"operation":{"description":"The underlying operations contained within the Bulk; shown as the endpoint for the equivalent single operation.","type":"string"},"mode":{"description":"The mode that was instructed when execution was started","$ref":"#/components/schemas/BulkProcessMode"}}}},"components/schemas/CorporateKybCompanyData":{"id":"components/schemas/CorporateKybCompanyData","kind":"json-schema","title":"CorporateKybCompanyData","data":{"type":"object","description":"Details about the main corporate. Identity fields (name, registration number, country) are taken from the corporate record and are not accepted here.","properties":{"registrationDate":{"type":"string","description":"Incorporation date, YYYY-MM-DD."},"legalForm":{"type":"string","maxLength":4,"description":"Legal form, ISO 20275 ELF code."},"classifications":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybClassification"}},"taxIdentifiers":{"type":"array","description":"The first entry maps to the provider's primary TIN; the rest are stored as supporting data.","items":{"$ref":"#/components/schemas/CorporateKybTaxIdentifier"}},"addresses":{"type":"array","description":"The first entry maps to the provider's primary address; the rest are stored as supporting data.","items":{"$ref":"#/components/schemas/CorporateKybAddress"}},"websiteUrl":{"type":"string","maxLength":500}}}},"components/schemas/CorporateKybCompanyNode":{"id":"components/schemas/CorporateKybCompanyNode","kind":"json-schema","title":"CorporateKybCompanyNode","data":{"type":"object","description":"An affiliated company in the ownership graph, referenced by relations.","required":["ref"],"properties":{"ref":{"type":"string","maxLength":100,"description":"Embedder-assigned reference for this company, used to wire up relations."},"details":{"$ref":"#/components/schemas/CorporateKybCompanyDetails"}}}},"components/schemas/CorporateKybIndividualNode":{"id":"components/schemas/CorporateKybIndividualNode","kind":"json-schema","title":"CorporateKybIndividualNode","data":{"type":"object","description":"An individual in the ownership graph, referenced by relations.","required":["ref"],"properties":{"ref":{"type":"string","maxLength":100,"description":"Embedder-assigned reference for this person, used to wire up relations."},"details":{"$ref":"#/components/schemas/CorporateKybIndividualDetails"},"isBeneficialOwner":{"type":"boolean"},"isControllingPerson":{"type":"boolean"},"isBusinessContact":{"type":"boolean"},"isSignatory":{"type":"boolean"},"isDelegator":{"type":"boolean"}}}},"components/schemas/CorporateKybRelation":{"id":"components/schemas/CorporateKybRelation","kind":"json-schema","title":"CorporateKybRelation","data":{"type":"object","description":"An ownership or control relationship between two entities in the graph.","required":["fromRef"],"properties":{"fromRef":{"type":"string","maxLength":100,"description":"Ref of the entity holding the stake or role."},"toRef":{"type":"string","maxLength":100,"description":"Ref of the company being held; leave empty to target the main corporate."},"roles":{"type":"array","items":{"type":"string","enum":["SHAREHOLDER","LEGAL_REPRESENTATIVE"]}},"ownershipPercentage":{"type":"number","format":"double","description":"0-100."},"votingRightsPercentage":{"type":"number","format":"double","description":"0-100."},"position":{"type":"string","maxLength":255}}}},"components/schemas/CorporateKybProfile":{"id":"components/schemas/CorporateKybProfile","kind":"json-schema","title":"CorporateKybProfile","data":{"type":"object","description":"Account-usage profile fields.","properties":{"fundingOrigin":{"type":"string"},"fundingOriginCountries":{"type":"array","items":{"type":"string","maxLength":2}},"fundingTransactionCountMonthly":{"type":"string"},"fundingTransactionValueMonthly":{"type":"string"},"collectionsEnabled":{"type":"boolean"},"collectionsPurpose":{"type":"string"},"collectionsOrigin":{"type":"string"},"collectionsOriginCountries":{"type":"array","items":{"type":"string","maxLength":2}},"collectionsTransactionCountMonthly":{"type":"string"},"collectionsTransactionValueMonthly":{"type":"string"},"withdrawalDestination":{"type":"string"},"withdrawalDestinationCountries":{"type":"array","items":{"type":"string","maxLength":2}},"withdrawalTransactionCountMonthly":{"type":"string"},"withdrawalTransactionValueMonthly":{"type":"string"},"payoutsEnabled":{"type":"boolean"},"payoutsPurpose":{"type":"string"},"payoutsDestination":{"type":"string"},"payoutsDestinationCountries":{"type":"array","items":{"type":"string","maxLength":2}},"payoutsTransactionCountMonthly":{"type":"string"},"payoutsTransactionValueMonthly":{"type":"string"},"cardsEnabled":{"type":"boolean"},"cardsTransactionCountMonthly":{"type":"string"},"cardsTransactionValueMonthly":{"type":"string"},"cardsPurpose":{"type":"string"},"cardsCardholderCount":{"type":"string"},"industry":{"$ref":"#/components/schemas/KybIndustry"},"sourceOfFunds":{"$ref":"#/components/schemas/KybSourceOfFunds"},"sourceOfFundsIsOther":{"type":"string"},"companyType":{"$ref":"#/components/schemas/CompanyType"},"customerOperatesSolelyInPermittedIndustries":{"type":"boolean"},"customerOperatesSolelyInPermittedJurisdictions":{"type":"boolean"},"isTheBusinessModelOfTheCustomerClear":{"type":"string"},"doesTheCustomersIntendedUsageAlignToTheirBusinessActivity":{"type":"boolean"},"doesTheCustomersIntendedUsageAlignToTheirBusinessActivityComment":{"type":"string"},"websiteUrl":{"type":"string","maxLength":500},"tradingName":{"type":"string","maxLength":255}}}},"components/schemas/KybDocumentType":{"id":"components/schemas/KybDocumentType","kind":"json-schema","title":"KybDocumentType","data":{"type":"string","description":"The kind of KYB supporting document.","enum":["REGISTRATION_CERTIFICATE","ARTICLES_OF_ASSOCIATION","SHAREHOLDER_REGISTER","PROOF_OF_ADDRESS","PROOF_OF_IDENTITY","BANK_STATEMENT","TAX_RETURN","ANNUAL_REPORT","SOURCE_OF_FUNDS","OTHER"]}},"components/schemas/SpendLimitUpdateMethod":{"id":"components/schemas/SpendLimitUpdateMethod","kind":"json-schema","title":"SpendLimitUpdateMethod","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The spend limit update method to apply. Currently 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":"OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLimit object i.e. sets new limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INCREMENT : This will increase the existing value of the spend limit by the amount input the value field. If used in conjunction with an ALWAYS interval, this can be used to increment a spend limit on a periodic basis (controlled by you, e.g. monthly), and means that any 'unused' balance from the previous period will still available to spend. See examples in our documentation"},"children":[]}]}]}]}],"enum":["OVERWRITE","INCREMENT"]}},"components/schemas/BeneficiaryId":{"id":"components/schemas/BeneficiaryId","kind":"json-schema","title":"BeneficiaryId","data":{"required":["beneficiaryId"],"type":"object","properties":{"beneficiaryId":{"$ref":"#/components/schemas/Id"}}}},"components/schemas/OutgoingWireTransferBeneficiary":{"id":"components/schemas/OutgoingWireTransferBeneficiary","kind":"json-schema","title":"OutgoingWireTransferBeneficiary","data":{"deprecated":true,"required":["name","bankAccountDetails"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the beneficiary of the outgoing wire transfer."},"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":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPABeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for SEPA/IBAN transfers or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Faster Payments transfers instead."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. The allowed length and pattern is dependent on the bank account details type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBANDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters. An extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"140"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters with a pattern of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(please note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"’"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))"},"children":[]}]}]}]},"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 beneficiary account. Required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified"},"children":[]}]}]}],"enum":["PERSONAL","BUSINESS"]},"address":{"maxLength":150,"minLength":1,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary’s address. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]}]},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"bankAccountDetails":{"description":"Details of the beneficiary bank account, depending on the type of transfer chosen.","oneOf":[{"$ref":"#/components/schemas/IBANDetails"},{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"}]},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/SEPABeneficiary":{"id":"components/schemas/SEPABeneficiary","kind":"json-schema","title":"SEPABeneficiary","data":{"required":["name","iban"],"type":"object","description":"Beneficiary details for SEPA/IBAN wire transfers.","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 150 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If SEPA does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative, in line with SEPA scheme guidance."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SEPA."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over SEPA."},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address. An extended character set is accepted to cater\nfor all European languages. If SEPA does not support a particular character,\nit is automatically converted to an acceptable alternative.\n"},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/SWIFTBeneficiary":{"id":"components/schemas/SWIFTBeneficiary","kind":"json-schema","title":"SWIFTBeneficiary","data":{"required":["name","account","address","bankCountry"],"type":"object","description":"Beneficiary details for SWIFT wire transfers.","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":"The beneficiary's full name."},"account":{"type":"string","minLength":1,"maxLength":34,"pattern":"^[a-zA-Z0-9]{1,34}$","description":"Can be either an account number or an International Bank Account Number (IBAN)."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{8,11}$","description":"Required if account is not an IBAN. Bank Identifier Code (BIC)."},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address."},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/RIXBeneficiary":{"id":"components/schemas/RIXBeneficiary","kind":"json-schema","title":"RIXBeneficiary","data":{"required":["name","iban"],"type":"object","description":"Beneficiary details for RIX wire transfers.","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 150 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If RIX does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over RIX."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over RIX."},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address. An extended character set is accepted to cater\nfor all European languages. If RIX does not support a particular character,\nit is automatically converted to an acceptable alternative.\n"},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/FasterPaymentsBeneficiary":{"id":"components/schemas/FasterPaymentsBeneficiary","kind":"json-schema","title":"FasterPaymentsBeneficiary","data":{"required":["name","type","accountNumber","sortCode"],"type":"object","description":"Beneficiary details for Faster Payments wire transfers.","properties":{"name":{"type":"string","minLength":1,"maxLength":140,"pattern":"^[a-zA-Z0-9\\/\\-?:().,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 140 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: the ' symbol is the unicode value U+2019 (right single quotation mark)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and not the unicode value U+0027 (apostrophe)."},"children":[]}]}]}]},"type":{"type":"string","description":"The type of beneficiary account. Required for Faster Payments.","enum":["PERSONAL","BUSINESS"]},"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Optional secondary reference for accounts without unique sort codes."},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address."},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/ExternalAccountId":{"id":"components/schemas/ExternalAccountId","kind":"json-schema","title":"ExternalAccountId","data":{"type":"object","description":"The id of an external account, such as a Linked Account, registered with the Weavr Platform.","required":["type","id"],"properties":{"type":{"$ref":"#/components/schemas/ExternalAccountType"},"id":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/AccountType":{"id":"components/schemas/AccountType","kind":"json-schema","title":"AccountType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An account can be of two types, Personal or Business:"},"children":[]}]}]},{"$$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":"PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity."},"children":[]}]}]}]}],"enum":["BUSINESS","PERSONAL"]}},"components/schemas/AccountNumberAndSortCode":{"id":"components/schemas/AccountNumberAndSortCode","kind":"json-schema","title":"AccountNumberAndSortCode","data":{"required":["accountNumber","sortCode"],"type":"object","description":"Bank details","properties":{"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number"},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code"},"secondaryReference":{"type":"string","description":"Optional secondary reference for accounts without unique sort codes."}}}},"components/schemas/Iban":{"id":"components/schemas/Iban","kind":"json-schema","title":"Iban","data":{"required":["iban"],"type":"object","description":"Bank details","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC, for wire transfer over SEPA or RIX."}}}},"components/schemas/AccountDescriptor":{"id":"components/schemas/AccountDescriptor","kind":"json-schema","title":"AccountDescriptor","data":{"required":["accountDescriptor"],"type":"object","description":"Identifier or account number which does not follow either the IBAN or Faster Payment (sort code and account number) format, such as a US bank account identifier.","properties":{"accountDescriptor":{"type":"string"}}}},"components/schemas/LinkedAccountState":{"id":"components/schemas/LinkedAccountState","kind":"json-schema","title":"LinkedAccountState","data":{"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 linked 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_VERIFICATION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending the completion of the required verification steps."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is verified and active, ready to be used for self-to-self wire transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /linked_accounts/{id}/unblock"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMOVED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Linked Account can transition through these different overall states, starting at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state until all verification steps are followed through."},"children":[]}]}]}]}],"enum":["PENDING_VERIFICATION","BLOCKED","ACTIVE","REJECTED","REMOVED"]}},"components/schemas/StringWrappedTypeId":{"id":"components/schemas/StringWrappedTypeId","kind":"json-schema","title":"StringWrappedTypeId","data":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"id":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/ManagedInstrumentBalance":{"id":"components/schemas/ManagedInstrumentBalance","kind":"json-schema","title":"ManagedInstrumentBalance","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instruments with funds have 2 balances, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the funds that are available for transactions such as purchases, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actualBalance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicating the funds that are actually on the instrument."},"children":[]}]}]}],"properties":{"availableBalance":{"type":"integer","format":"int64","description":"The funds available for transactions on the instrument. Funds that are blocked or pending are not included in the available balance."},"actualBalance":{"type":"integer","format":"int64","description":"The funds that are actually on the instrument. Funds that are blocked or pending, due to for example, a purchase authorisation or a pending deposit, are included in the actual balance."}}}},"components/schemas/ManagedInstrumentState":{"id":"components/schemas/ManagedInstrumentState","kind":"json-schema","title":"ManagedInstrumentState","data":{"required":["state"],"type":"object","properties":{"state":{"$ref":"#/components/schemas/InstrumentState"},"blockedReason":{"$ref":"#/components/schemas/BlockedReason"},"destroyedReason":{"$ref":"#/components/schemas/DestroyedReason"}}}},"components/schemas/CorporateRootUser":{"id":"components/schemas/CorporateRootUser","kind":"json-schema","title":"CorporateRootUser","data":{"required":["id","email","name","surname","mobile","active","emailVerified","mobileNumberVerified","companyPosition"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/IdentityId"},"name":{"maxLength":100,"type":"string","description":"First name of the root user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"companyPosition":{"$ref":"#/components/schemas/CompanyPosition"},"active":{"type":"boolean","description":"The state of the root user. If false, then the user will not be able to log in."},"emailVerified":{"type":"boolean","description":"Indicates if the root user's email has been verified."},"mobileNumberVerified":{"type":"boolean","description":"Indicates if the root user's mobile number has been verified."},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}}},"components/schemas/LegalAddress":{"id":"components/schemas/LegalAddress","kind":"json-schema","title":"LegalAddress","data":{"required":["addressLine1","city","country"],"type":"object","description":"The legal address of the company. This information is captured via the Due Diligence (KYB) process.","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string"},"state":{"maxLength":50,"type":"string"},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"Country of the identity in ISO 3166 alpha-2 format."}}}},"components/schemas/ConsumerRootUser":{"id":"components/schemas/ConsumerRootUser","kind":"json-schema","title":"ConsumerRootUser","data":{"required":["id","email","name","surname","active","mobile","emailVerified","mobileNumberVerified"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/IdentityId"},"name":{"maxLength":100,"type":"string","description":"First name of the root user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"occupation":{"$ref":"#/components/schemas/Occupation"},"active":{"type":"boolean","description":"The state of the root user. If false, then the user will not be able to log in."},"emailVerified":{"type":"boolean","description":"Indicates if the root user's email has been verified."},"mobileNumberVerified":{"type":"boolean","description":"Indicates if the root user's mobile number has been verified."},"dateOfBirth":{"description":"Date of birth of the consumer root user.","$ref":"#/components/schemas/Date"},"address":{"description":"Address of the consumer root user.","$ref":"#/components/schemas/AddressWithNoRequiredFields"},"nationality":{"description":"Nationality of the consumer root user, in ISO 3166 alpha-2 format.","$ref":"#/components/schemas/Nationality"},"placeOfBirth":{"type":"string","description":"The place of birth of the consumer root user."},"tag":{"$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}}},"components/schemas/CardAuthorisationDetailsAuthorisationType":{"id":"components/schemas/CardAuthorisationDetailsAuthorisationType","kind":"json-schema","title":"CardAuthorisationDetailsAuthorisationType","data":{"type":"string","enum":["AUTHORISED","AUTHORISED_CREDIT"]}},"components/schemas/MerchantData":{"id":"components/schemas/MerchantData","kind":"json-schema","title":"MerchantData","data":{"required":["merchantName","merchantCategoryCode","merchantId"],"type":"object","properties":{"merchantName":{"type":"string","description":"The name of the merchant where the authorisation has been made."},"merchantCategoryCode":{"type":"string","description":"The merchant category code."},"merchantId":{"type":"string","description":"The merchant ID."},"merchantDescription":{"type":"string","description":"The merchant description"},"merchantStreet":{"type":"string","description":"The merchant street address (if available)"},"merchantCity":{"type":"string","description":"The merchant city (if available)"},"merchantState":{"type":"string","description":"The merchant state address (if available)"},"merchantPostalCode":{"type":"string","description":"The merchant postal code (if available)"},"merchantCountry":{"type":"string","description":"The merchant country address"},"merchantTelephone":{"type":"string","description":"The merchant telephone number"},"merchantURL":{"type":"string","description":"The merchant URL"},"merchantNameOther":{"type":"string","description":"The alternative merchant name"},"merchantNetworkId":{"type":"string","description":"The merchant's network id"},"merchantContact":{"type":"string","description":"The merchant's contact (if available)"}}}},"components/schemas/CardHolderPresent":{"id":"components/schemas/CardHolderPresent","kind":"json-schema","title":"CardHolderPresent","data":{"type":"string","enum":["PRESENT","NOT_PRESENT","PRESENCE_UNKNOWN"]}},"components/schemas/CardAuthorisationDetailsTransactionType":{"id":"components/schemas/CardAuthorisationDetailsTransactionType","kind":"json-schema","title":"CardAuthorisationDetailsTransactionType","data":{"enum":["SALE_PURCHASE","MAIL_OR_TELEPHONE_ORDER","CASH_WITHDRAWAL","ORIGINAL_CREDIT_TRANSACTION","ACCOUNT_FUNDING_TRANSACTION","CASH_DISBURSEMENT","PURCHASE_REFUND","BALANCE_INQUIRY","PIN_CHANGE","PIN_UNBLOCK"],"type":"string"}},"components/schemas/PrepaidModeCardAuthorisationEvent":{"id":"components/schemas/PrepaidModeCardAuthorisationEvent","kind":"json-schema","title":"PrepaidModeCardAuthorisationEvent","data":{"allOf":[{"$ref":"#/components/schemas/CardAuthorisationEvent"},{"type":"object","required":["currency"],"properties":{"availableBalance":{"description":"The card available balance before this authorisation is processed.","$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/DebitModeCardAuthorisationEvent":{"id":"components/schemas/DebitModeCardAuthorisationEvent","kind":"json-schema","title":"DebitModeCardAuthorisationEvent","data":{"allOf":[{"$ref":"#/components/schemas/CardAuthorisationEvent"},{"type":"object","required":["parentManagedAccountId"],"properties":{"parentManagedAccountId":{"type":"string","description":"Id of the managed account holding funds which the managed card can access, up to a configurable spend limit."},"availableToSpend":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of funds from the parent managed account that are available to be spent through the card, in a given time interval, "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this transaction is performed."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AvailableToSpend"}}}}]}},"components/schemas/BulkProcessMode":{"id":"components/schemas/BulkProcessMode","kind":"json-schema","title":"BulkProcessMode","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail."},"children":[]}]}]}],"type":"string","enum":["ON_FAILURE_STOP","ON_FAILURE_CONTINUE"]}},"components/schemas/CompanyPosition":{"id":"components/schemas/CompanyPosition","kind":"json-schema","title":"CompanyPosition","data":{"type":"string","description":"The company position of the Corporate Root User.","enum":["DIRECTOR","AUTHORISED_REPRESENTATIVE"]}},"components/schemas/LinkedAccountProfileId":{"id":"components/schemas/LinkedAccountProfileId","kind":"json-schema","title":"LinkedAccountProfileId","data":{"type":"string","description":"The id of the Linked Account Profile which this instrument is linked to.\n\nYou can have one or more profiles linked to your application, and these can be used to drive different behaviours according to your product's needs.\n\nThis field is necessary only if you have been provided with multiple Linked Account Profiles.\n\nProfile Ids can be found in the Multi Portal, in the API Credentials page.\n","pattern":"^[0-9]+$"}},"components/schemas/PrepaidModeCardRequest":{"id":"components/schemas/PrepaidModeCardRequest","kind":"json-schema","title":"PrepaidModeCardRequest","data":{"allOf":[{"$ref":"#/components/schemas/ManagedCardRequest"},{"type":"object","required":["currency"],"properties":{"currency":{"$ref":"#/components/schemas/Currency"}}}]}},"components/schemas/DebitModeCardRequest":{"id":"components/schemas/DebitModeCardRequest","kind":"json-schema","title":"DebitModeCardRequest","data":{"allOf":[{"$ref":"#/components/schemas/ManagedCardRequest"},{"type":"object","required":["parentManagedAccountId"],"properties":{"parentManagedAccountId":{"type":"string","pattern":"^[0-9]+$","description":"Id of the managed account holding funds which the managed card will access, up to a configurable spend limit."},"userCurrency":{"$ref":"#/components/schemas/SupportedUserCurrency"}}}]}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"maxLength":20,"minLength":5,"pattern":"^\\+[0-9]+$","type":"string"}},"components/schemas/BaseCardLevelSpendRules":{"id":"components/schemas/BaseCardLevelSpendRules","kind":"json-schema","title":"BaseCardLevelSpendRules","data":{"allOf":[{"$ref":"#/components/schemas/CommonLevelSpendRules"},{"type":"object","properties":{"spendLimit":{"description":"The total amount of funds that can be spent using this card, in a given time interval.","type":"array","items":{"$ref":"#/components/schemas/SpendLimit"}}}}]}},"components/schemas/TransactionCancelRequest":{"id":"components/schemas/TransactionCancelRequest","kind":"json-schema","title":"TransactionCancelRequest","data":{"required":["id"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction."},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"}}}},"components/schemas/TransactionCancellationReason":{"id":"components/schemas/TransactionCancellationReason","kind":"json-schema","title":"TransactionCancellationReason","data":{"type":"string","pattern":"^[ a-zA-Z0-9_-]+$","maxLength":50,"description":"The reason the scheduled transaction was cancelled."}},"components/schemas/CorrespondentBankingIndividualOriginator":{"id":"components/schemas/CorrespondentBankingIndividualOriginator","kind":"json-schema","title":"CorrespondentBankingIndividualOriginator","data":{"required":["name","address","country","bankAccountDetails"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An individual (natural person) originator of the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Rule 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":"Mandatory: Full name and account number (via bankAccountDetails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: At least one supplementary information type (address + birth details, or address + official ID)"},"children":[]}]}]}]}],"properties":{"tag":{"$ref":"#/components/schemas/Tag"},"name":{"type":"string","maxLength":140,"description":"Full name of the individual as documented on official ID."},"address":{"type":"string","maxLength":255,"description":"Full residential address of the individual."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code."},"bankAccountDetails":{"$ref":"#/components/schemas/CorrespondentBankingBankAccountDetails","description":"Account and financial institution details of the originator (travel rule mandatory)."},"supplementaryInformation":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingIndividualAddressAndIdInfo"},{"$ref":"#/components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo"}]}}}},"components/schemas/CorrespondentBankingBusinessOriginator":{"id":"components/schemas/CorrespondentBankingBusinessOriginator","kind":"json-schema","title":"CorrespondentBankingBusinessOriginator","data":{"required":["name","registrationAddress","registrationCountry","bankAccountDetails"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business (legal entity) originator of the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Rule 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":"Mandatory: Full legal name and account number (via bankAccountDetails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: Registered address and business identification (LEI, registration number, or tax ID)"},"children":[]}]}]}]}],"properties":{"tag":{"$ref":"#/components/schemas/Tag"},"name":{"type":"string","maxLength":140,"description":"Full legal name of the business entity."},"registrationAddress":{"type":"string","maxLength":255,"description":"Registered address of the business entity."},"registrationCountry":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code of registration."},"bankAccountDetails":{"$ref":"#/components/schemas/CorrespondentBankingBankAccountDetails","description":"Account and financial institution details of the originator (travel rule mandatory)."},"supplementaryInformation":{"$ref":"#/components/schemas/CorrespondentBankingBusinessAddressAndIdInfo"}}}},"components/schemas/CorrespondentBankingSEPABeneficiary":{"id":"components/schemas/CorrespondentBankingSEPABeneficiary","kind":"json-schema","title":"CorrespondentBankingSEPABeneficiary","data":{"required":["name","iban","address"],"type":"object","description":"CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If SEPA does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative, in line with SEPA scheme guidance."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SEPA."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over SEPA."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingRIXBeneficiary":{"id":"components/schemas/CorrespondentBankingRIXBeneficiary","kind":"json-schema","title":"CorrespondentBankingRIXBeneficiary","data":{"required":["name","iban","address"],"type":"object","description":"CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If RIX does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over RIX."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over RIX."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingFasterPaymentsBeneficiary":{"id":"components/schemas/CorrespondentBankingFasterPaymentsBeneficiary","kind":"json-schema","title":"CorrespondentBankingFasterPaymentsBeneficiary","data":{"required":["name","type","accountNumber","sortCode","address"],"type":"object","description":"CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"pattern":"^[a-zA-Z0-9\\/\\-?:().,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: the ' symbol is the unicode value U+2019 (right single quotation mark)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and not the unicode value U+0027 (apostrophe)."},"children":[]}]}]}]},"type":{"type":"string","description":"The type of beneficiary account. Required for Faster Payments.","enum":["PERSONAL","BUSINESS"]},"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Optional secondary reference for accounts without unique sort codes."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingExternalData":{"id":"components/schemas/CorrespondentBankingExternalData","kind":"json-schema","title":"CorrespondentBankingExternalData","data":{"type":"object","description":"External data key-value pair.","required":["name","value"],"properties":{"name":{"type":"string","maxLength":50,"description":"Name/key of the external data."},"value":{"type":"string","maxLength":255,"description":"Value of the external data."}}}},"components/schemas/BeneficiaryTrustLevel":{"id":"components/schemas/BeneficiaryTrustLevel","kind":"json-schema","title":"BeneficiaryTrustLevel","data":{"type":"string","description":"The value that determines whether a Beneficiary is trusted or not.","enum":["TRUSTED"]}},"components/schemas/BusinessBeneficiaryType":{"id":"components/schemas/BusinessBeneficiaryType","kind":"json-schema","title":"BusinessBeneficiaryType","data":{"required":["businessName"],"type":"object","properties":{"businessName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business beneficiary name. The allowed length and pattern is dependent on the beneficiary details type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstrumentDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBANDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"140"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters with a pattern of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(please note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"’"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))"},"children":[]}]}]}]}}}},"components/schemas/ConsumerBeneficiaryType":{"id":"components/schemas/ConsumerBeneficiaryType","kind":"json-schema","title":"ConsumerBeneficiaryType","data":{"required":["fullName"],"type":"object","properties":{"nationality":{"type":"string","description":"The nationality of the consumer. Must be a valid ISO 3166-1 alpha-2 country code (e.g., 'GB', 'FR').","pattern":"^[A-Z]{2}$"},"dateOfBirth":{"type":"string","description":"The date of birth of the consumer. Must be a valid date in ISO 8601 format (YYYY-MM-DD) and should not be a future date.","format":"date"},"fullName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The person beneficiary name. The allowed length and pattern is dependent on the beneficiary details type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstrumentDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBANDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"140"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters with a pattern of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(please note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"’"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))"},"children":[]}]}]}]}}}},"components/schemas/InstrumentDetailsBeneficiary":{"id":"components/schemas/InstrumentDetailsBeneficiary","kind":"json-schema","title":"InstrumentDetailsBeneficiary","data":{"required":["instrument"],"type":"object","description":"Represents a Weavr beneficiary instrument typically used in Send transactions.","properties":{"instrument":{"$ref":"#/components/schemas/InstrumentId"}}}},"components/schemas/BankAccountDetailsBeneficiary":{"id":"components/schemas/BankAccountDetailsBeneficiary","kind":"json-schema","title":"BankAccountDetailsBeneficiary","data":{"required":["bankAccountDetails"],"type":"object","description":"Represent the beneficiary bank account typically used in Outgoing Wire Transfer transactions.","properties":{"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address."},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"bankAccountDetails":{"description":"Details of the beneficiary bank account, depending on the type of transfer chosen.","oneOf":[{"$ref":"#/components/schemas/IBANDetails"},{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"}]}}}},"components/schemas/PasswordValidateComplexityIssueCode":{"id":"components/schemas/PasswordValidateComplexityIssueCode","kind":"json-schema","title":"PasswordValidateComplexityIssueCode","data":{"enum":["PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE"],"type":"string"}},"components/schemas/SCAChallengeType":{"id":"components/schemas/SCAChallengeType","kind":"json-schema","title":"SCAChallengeType","data":{"type":"string","enum":["OTP","PUSH","BIOMETRIC"],"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":"text","inline":true,"attributes":{"content":"\"OTP\": The OTP is sent as a text message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"PUSH\": The authorisation request is sent as a push notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"BIOMETRIC\": The push notification is sent via Firebase to a mobile application"},"children":[]}]}]}]}]}},"components/schemas/SCAFactorStatus":{"id":"components/schemas/SCAFactorStatus","kind":"json-schema","title":"SCAFactorStatus","data":{"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 factor 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":"PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : The user has started the enrolment process but still hasn't completed enrolment. Challenges cannot be used before they are verified."},"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 has successfully completed enrolment and the challenge can be used to verify transactions."},"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 user has rejected the enrolment."},"children":[]}]}]}]}],"enum":["PENDING_VERIFICATION","ACTIVE","INACTIVE"]}},"components/schemas/SCAChannel":{"id":"components/schemas/SCAChannel","kind":"json-schema","title":"SCAChannel","data":{"type":"string","enum":["SMS","AUTHY","BIOMETRIC"],"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":"text","inline":true,"attributes":{"content":"\"SMS\": The one-time-password is sent as a text message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"AUTHY\": The push notification is sent to an Authy application"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"BIOMETRIC\": The push notification is sent to an innovator application"},"children":[]}]}]}]}]}},"components/schemas/BulkProcessConflictErrorCode":{"id":"components/schemas/BulkProcessConflictErrorCode","kind":"json-schema","title":"BulkProcessConflictErrorCode","data":{"enum":["VALIDATION_FAILED","USER_VALIDATION_FAILED","ALREADY_SUBMITTED","DUPLICATE_OPERATION_TYPE","NO_CONFIG_FOUND","INVALID_STATE","TOO_MANY_REQUESTS"],"type":"string"}},"components/schemas/BulkProcessOperationStatusCounts":{"id":"components/schemas/BulkProcessOperationStatusCounts","kind":"json-schema","title":"BulkProcessOperationStatusCounts","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/BulkProcessOperationStatus"},"count":{"type":"integer"}}}},"components/schemas/BulkProcessOperation":{"id":"components/schemas/BulkProcessOperation","kind":"json-schema","title":"BulkProcessOperation","data":{"type":"object","properties":{"operationId":{"description":"Id of a specific bulk operation. Useful only if you need to refer to a specific operation when reporting an issue","type":"string"},"sequence":{"description":"The operations submitted in a Bulk Processes are executed in sequence. This field indicates the position of this specific operation in the context of such sequence","format":"int32","type":"integer"},"method":{"description":"HTTP request method used for the executed operation within the Bulk process","type":"string"},"path":{"description":"The endpoint path for the Operation","type":"string"},"status":{"description":"The execution status of the operation within the Bulk Process. This can be one of: \"SUBMITTED\" \"RUNNING\" \"COMPLETED\" \"FAILED\" \"CANCELLED\"\n","$ref":"#/components/schemas/BulkProcessOperationStatus"},"requestPayload":{"description":"This is the payload for the execution of an operation within the context of a Bulk Process","type":"string"},"responsePayload":{"description":"The response for the execution of the operation","type":"string"}}}},"components/schemas/UserIdentity":{"id":"components/schemas/UserIdentity","kind":"json-schema","title":"UserIdentity","data":{"required":["id","name"],"type":"object","properties":{"id":{"description":"The unique identifier of the Corporate Identity.","$ref":"#/components/schemas/IdentityId"},"name":{"type":"string","description":"The name of the company."}}}},"components/schemas/CreatedCorporateRootUser":{"id":"components/schemas/CreatedCorporateRootUser","kind":"json-schema","title":"CreatedCorporateRootUser","data":{"allOf":[{"$ref":"#/components/schemas/CorporateRootUser"},{"type":"object","required":["passwordAlreadySet"],"properties":{"passwordAlreadySet":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the corporate root user is a single email multiple identities user, this field returns true, indicating that there is no need to call the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"passwordCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation for this user."},"children":[]}]}]}]}}}]}},"components/schemas/KybRunStatus":{"id":"components/schemas/KybRunStatus","kind":"json-schema","title":"KybRunStatus","data":{"type":"string","enum":["COLLECTION.NOT_STARTED","COLLECTION.READY_TO_START","COLLECTION.IN_PROGRESS","REVIEW.IN_PROGRESS","RESUBMISSION.IN_PROGRESS","KYB_RUN.APPROVED","KYB_RUN.REJECTED","KYB_RUN.CANCELLED"]}},"components/schemas/KybRunType":{"id":"components/schemas/KybRunType","kind":"json-schema","title":"KybRunType","data":{"type":"string","enum":["INITIAL_ONBOARDING","REFRESH"]}},"components/schemas/CorporateKybDocument":{"id":"components/schemas/CorporateKybDocument","kind":"json-schema","title":"CorporateKybDocument","data":{"type":"object","description":"Metadata for a document uploaded to a corporate's KYB.","properties":{"reference":{"type":"string","maxLength":100,"description":"The stored document's reference."},"documentType":{"$ref":"#/components/schemas/KybDocumentType"},"description":{"type":"string","maxLength":500},"filename":{"type":"string","maxLength":255}}}},"components/schemas/TransactionId":{"id":"components/schemas/TransactionId","kind":"json-schema","title":"TransactionId","data":{"required":["type","id"],"type":"object","properties":{"type":{"enum":["AUTHORISATION","SETTLEMENT","MANUAL_TRANSACTION","TRANSFER","SEND","DEPOSIT","AUTHORISATION_REVERSAL","AUTHORISATION_EXPIRY","AUTHORISATION_DECLINE","AUTHORISATION_MANUAL_CLOSE","MERCHANT_REFUND","MERCHANT_REFUND_REVERSAL","ORIGINAL_CREDIT_TRANSACTION","SETTLEMENT_REVERSAL","ADJUSTMENT","CHARGE_FEE","WITHDRAWAL_RESERVE","WITHDRAWAL_RELEASE","FEE_REVERSAL","OUTGOING_WIRE_TRANSFER","AUTHORISATION_CANCELLATION","SYSTEM_TRANSACTION","OUTGOING_DIRECT_DEBIT_COLLECTION","OUTGOING_DIRECT_DEBIT_REFUND","LINKED_ACCOUNT_VERIFICATION_TRANSFER","INCOMING_WIRE_TRANSFER","FUNDING","TEST_FUNDING","CORRESPONDENT_BANK_TRANSFER"],"type":"string","x-enumDescriptions":{"AUTHORISATION":"","SETTLEMENT":"","MANUAL_TRANSACTION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a manual transaction, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain a description with the reason for the transaction. This will start with one of the following prefixes:"},"children":[]}]}]},{"$$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":"Account Closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chargebacks - Represented"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chargebacks - Won"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleted Card - Transfer from"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleted Card - Transfer to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate Authorisation Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate Settlement Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired Card - Transfer from"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired Card - Transfer to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex Padding Release Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds Redemption & Account Closure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual Auth Expiry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing Settlement Issue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Negative Card Balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reversal - Duplicate Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reversal - Manual Auth Expiry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reversal - Manual Transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amend Balance - Auth Expiry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completing Deposit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate Deposit"},"children":[]}]}]}]}],"TRANSFER":"","SEND":"","DEPOSIT":"","AUTHORISATION_REVERSAL":"","AUTHORISATION_EXPIRY":"","AUTHORISATION_DECLINE":"","AUTHORISATION_MANUAL_CLOSE":"","MERCHANT_REFUND":"","MERCHANT_REFUND_REVERSAL":"","ORIGINAL_CREDIT_TRANSACTION":"","SETTLEMENT_REVERSAL":"","ADJUSTMENT":"","CHARGE_FEE":"","WITHDRAWAL_RESERVE":"","WITHDRAWAL_RELEASE":"","FEE_REVERSAL":"","OUTGOING_WIRE_TRANSFER":"","AUTHORISATION_CANCELLATION":"","SYSTEM_TRANSACTION":"","OUTGOING_DIRECT_DEBIT_COLLECTION":"","OUTGOING_DIRECT_DEBIT_REFUND":""}},"id":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/FeeTransaction":{"id":"components/schemas/FeeTransaction","kind":"json-schema","title":"FeeTransaction","data":{"type":"object","required":["id","feeType","amount","instrument","status","creationTimestamp"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee charged or reversed on an instrument. Surfaced through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Transaction Activity), and as line items on statements."},"children":[]}]}]}],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the fee transaction."},"feeType":{"$ref":"#/components/schemas/FeeSubtype"},"amount":{"description":"The fee amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"instrument":{"description":"The instrument the fee was charged against.","$ref":"#/components/schemas/InstrumentId"},"status":{"$ref":"#/components/schemas/FeeTransactionStatus"},"description":{"type":"string","maxLength":255},"relatedTransactionId":{"type":"string","pattern":"^[0-9]+$","description":"The parent transaction this fee relates to, if any."},"creationTimestamp":{"type":"integer","format":"int64"},"lastUpdatedTimestamp":{"type":"integer","format":"int64"}}}},"components/schemas/LinkedAccountVerificationStep":{"id":"components/schemas/LinkedAccountVerificationStep","kind":"json-schema","title":"LinkedAccountVerificationStep","data":{"type":"string","enum":["TRANSFER_INSTRUCTION","USER_DECLARATION_SCA_CHALLENGE","INTERNAL_CHECKS","MICRO_DEPOSIT"]}},"components/schemas/LinkedAccountVerificationTransferInstruction":{"id":"components/schemas/LinkedAccountVerificationTransferInstruction","kind":"json-schema","title":"LinkedAccountVerificationTransferInstruction","data":{"type":"object","required":["amount","reference"],"properties":{"amount":{"$ref":"#/components/schemas/CurrencyAmount"},"reference":{"type":"string"},"destination":{"type":"object","properties":{"accountOwnerName":{"type":"string"},"accountType":{"$ref":"#/components/schemas/AccountType"},"accountReference":{"oneOf":[{"$ref":"#/components/schemas/Iban"},{"$ref":"#/components/schemas/AccountNumberAndSortCode"},{"$ref":"#/components/schemas/AccountDescriptor"}]}}}}}},"components/schemas/LinkedAccountMicroDepositVerification":{"id":"components/schemas/LinkedAccountMicroDepositVerification","kind":"json-schema","title":"LinkedAccountMicroDepositVerification","data":{"type":"object","required":["amount"],"properties":{"amount":{"$ref":"#/components/schemas/CurrencyAmount"},"senderName":{"type":"string"}}}},"components/schemas/LinkedAccountVerificationStepStatus":{"id":"components/schemas/LinkedAccountVerificationStepStatus","kind":"json-schema","title":"LinkedAccountVerificationStepStatus","data":{"type":"string","enum":["PENDING_USER","PENDING_REVIEW","PENDING_EXECUTION","REJECTED","COMPLETED"]}},"components/schemas/IBANDetails":{"id":"components/schemas/IBANDetails","kind":"json-schema","title":"IBANDetails","data":{"required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA or RIX","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SEPA or RIX"},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC, for wire transfer over SEPA or RIX"}}}},"components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails":{"id":"components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails","kind":"json-schema","title":"FasterPaymentsBankDetailsOrBACSBankDetails","data":{"required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string"}}}},"components/schemas/SwiftBankDetails":{"id":"components/schemas/SwiftBankDetails","kind":"json-schema","title":"SwiftBankDetails","data":{"required":["iban","code"],"type":"object","description":"Bank details used in case the wire transfer is executed over SWIFT.","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SWIFT."},"code":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"SWIFT code, identifying a particular bank or branch, required for wire transfer over SWIFT."}}}},"components/schemas/StatementEntryState":{"id":"components/schemas/StatementEntryState","kind":"json-schema","title":"StatementEntryState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction entry state, 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":"text","inline":true,"attributes":{"content":"PENDING: The transaction has started and some of the fund movements have completed, however additional fund movements are still pending to finalise the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: All fund movements for a transaction have completed."},"children":[]}]}]}]}],"enum":["PENDING","COMPLETED"]}},"components/schemas/ScaledAmount":{"id":"components/schemas/ScaledAmount","kind":"json-schema","title":"ScaledAmount","data":{"type":"object","properties":{"value":{"type":"integer","format":"int64"},"scale":{"maximum":127,"minimum":-128,"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":"A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale)."},"children":[]}]}]}]}},"components/schemas/UserCurrencyTransactionDetails":{"id":"components/schemas/UserCurrencyTransactionDetails","kind":"json-schema","title":"UserCurrencyTransactionDetails","data":{"required":["userTransactionAmount","userExchangeRate"],"type":"object","properties":{"userTransactionAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"type":"string"}},"description":"The object representing the user transaction's currency, amount and rate."}},"components/schemas/StatementResponseEntry":{"id":"components/schemas/StatementResponseEntry","kind":"json-schema","title":"StatementResponseEntry","data":{"type":"object","required":["entryId","balanceAdjustment","balanceAfter","timestamp","transaction"],"description":"A single entry in an instrument statement. Each entry represents a posted transaction\nthat caused the actual balance of the instrument to change.\n","properties":{"entryId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of this statement entry."},"transaction":{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},"description":{"type":"string","maxLength":255,"description":"Human-readable description or reference for the entry."},"timestamp":{"type":"integer","format":"int64","description":"When the transaction was posted to the statement, expressed in Epoch timestamp using millisecond precision."},"balanceAdjustment":{"description":"The amount credited (positive) or debited (negative) on the actual balance of the instrument.","$ref":"#/components/schemas/CurrencyAmount"},"balanceAfter":{"description":"The balance of the instrument after this entry was posted.","$ref":"#/components/schemas/CurrencyAmount"},"counterparty":{"oneOf":[{"$ref":"#/components/schemas/MerchantCounterparty"},{"$ref":"#/components/schemas/InstrumentCounterparty"},{"$ref":"#/components/schemas/BankAccountCounterparty"}]},"fee":{"$ref":"#/components/schemas/FeeSummary"},"forex":{"$ref":"#/components/schemas/TransactionForex"},"relatedEntryId":{"type":"string","pattern":"^[0-9]+$","description":"The ID of a related statement entry (e.g. a fee entry linked to its parent transaction entry)."},"executingAccessInstrument":{"$ref":"#/components/schemas/StatementResponseEntryExecutingAccessInstrument"}}}},"components/schemas/FeeSummary":{"id":"components/schemas/FeeSummary","kind":"json-schema","title":"FeeSummary","data":{"type":"object","required":["id","type","amount"],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the fee — same value used as entryId on the corresponding fees-type entry, and as the fee transaction id in the Transaction Activity API."},"children":[]}]}]}],"type":"string","pattern":"^[0-9]+$"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Aligns with the top-level transaction type."},"children":[]}]}]}],"type":"string","enum":["fees"]},"amount":{"description":"Fee amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"subtype":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorises the fee — derived from the parent transaction type."},"children":[]}]}]}],"$ref":"#/components/schemas/FeeSubtype"}}}},"components/schemas/SystemTransaction":{"id":"components/schemas/SystemTransaction","kind":"json-schema","title":"SystemTransaction","data":{"type":"object","required":["id","amount","instrument","status","creationTimestamp"],"description":"A system-generated transaction applied to an instrument by the platform (balance adjustments,\naccount closures, dispute outcomes, replacement balance transfers, etc.). Only surfaced\nthrough Transaction Activity.\n","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the system transaction."},"subtype":{"$ref":"#/components/schemas/SystemTransactionSubtype"},"amount":{"description":"The transaction amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"instrument":{"description":"The instrument the transaction was applied to.","$ref":"#/components/schemas/InstrumentId"},"status":{"$ref":"#/components/schemas/TransactionActivityStatus"},"reason":{"type":"string","maxLength":255,"description":"Operational reason or context for the system transaction."},"relatedTransactionId":{"type":"string","pattern":"^[0-9]+$","description":"A related transaction this system event corrects or compensates, if any."},"creationTimestamp":{"type":"integer","format":"int64"},"lastUpdatedTimestamp":{"type":"integer","format":"int64"}}}},"components/schemas/SensitiveCardNumber":{"id":"components/schemas/SensitiveCardNumber","kind":"json-schema","title":"SensitiveCardNumber","data":{"type":"object","description":"The full card number of the card.\n\nUnless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card number will be tokenised.\n\nTo show the full unredacted card number to your user, you need to embed the Card number UI Component in your application. This accepts the tokenised card number and shows the unredacted card number to the user on screen.\n\nIn addition, it is returned only when the current session is stepped-up.\n","properties":{"value":{"maxLength":16,"type":"string"}}}},"components/schemas/SensitiveCvv":{"id":"components/schemas/SensitiveCvv","kind":"json-schema","title":"SensitiveCvv","data":{"type":"object","description":"The CVV of the card.\n\nUnless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card's CVV will be tokenised.\n\nTo show the card's CVV to your user, you need to embed the CVV UI Component in your application. This accepts the tokenised CVV and shows the plain text CVV number to the user on screen.\n\nIn addition, it is returned only when the current session is stepped-up.\n","properties":{"value":{"maxLength":3,"type":"string"}}}},"components/schemas/PhysicalCardDetails":{"id":"components/schemas/PhysicalCardDetails","kind":"json-schema","title":"PhysicalCardDetails","data":{"required":["pendingActivation"],"type":"object","properties":{"bulkDelivery":{"$ref":"#/components/schemas/BulkCardDelivery"},"productReference":{"type":"string","description":"The unique reference indicating the configuration of the physical card. Example the card design."},"carrierType":{"type":"string"},"pendingActivation":{"type":"boolean","description":"Indicates if the physical card is activated for physical usage such as with physical terminals."},"pinBlocked":{"type":"boolean","description":"Indicates if the physical card is blocked due to providing incorrect PINs."},"manufacturingState":{"$ref":"#/components/schemas/ManufacturingState"},"replacement":{"deprecated":true,"type":"object","description":"Indicates if the physical card is replaced by another card.","properties":{"replacementReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the physical card was replaced."},"children":[]}]}]},{"$$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":"DAMAGED: The physical card was damaged and cannot be used at a physical terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST_STOLEN: The physical card was either lost or stolen and cannot be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: The physical card expired."},"children":[]}]}]}]}],"enum":["DAMAGED","LOST_STOLEN","EXPIRED"]},"replacementId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the new card that replaces this card."}}},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"deliveryMethod":{"$ref":"#/components/schemas/DeliveryMethod"},"deliveryTrackingCode":{"$ref":"#/components/schemas/DeliveryTrackingCode"},"deliveryTrackingMethod":{"$ref":"#/components/schemas/DeliveryTrackingMethod"},"deliveryTrackingUrl":{"$ref":"#/components/schemas/DeliveryTrackingUrl"},"nameOnCardLine2":{"deprecated":true,"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards. This field is deprecated"}}}},"components/schemas/ManagedCardReplacement":{"id":"components/schemas/ManagedCardReplacement","kind":"json-schema","title":"ManagedCardReplacement","data":{"description":"Indicates if the card is replaced by another card.","type":"object","required":["id","reason"],"properties":{"id":{"description":"The id of the replacement card","pattern":"^[0-9]+$","type":"string"},"reason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the card was replaced."},"children":[]}]}]},{"$$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":"DAMAGED: The physical card was damaged and cannot be used at a physical terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST_STOLEN: The physical card was either lost or stolen and cannot be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: The card expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPROMISED: The virtual card was compromised; the virtual card details have been exposed or accessed without authorization."},"children":[]}]}]}]}],"type":"string","enum":["DAMAGED","LOST_STOLEN","EXPIRED","COMPROMISED"]}}}},"components/schemas/PrepaidModeCard":{"id":"components/schemas/PrepaidModeCard","kind":"json-schema","title":"PrepaidModeCard","data":{"allOf":[{"$ref":"#/components/schemas/ManagedCard"},{"type":"object","properties":{"balances":{"$ref":"#/components/schemas/ManagedInstrumentBalance"}}}]}},"components/schemas/DebitModeCard":{"id":"components/schemas/DebitModeCard","kind":"json-schema","title":"DebitModeCard","data":{"allOf":[{"$ref":"#/components/schemas/ManagedCard"},{"type":"object","required":["parentManagedAccountId"],"properties":{"parentManagedAccountId":{"type":"string","pattern":"^[0-9]+$","description":"Id of the managed account holding funds which the managed card will access, up to a configurable spend limit."},"userCurrency":{"$ref":"#/components/schemas/SupportedUserCurrency"},"availableToSpend":{"description":"The amount of funds from the parent managed account that are available to be spent through the card, in a given time interval.","type":"array","items":{"$ref":"#/components/schemas/AvailableToSpend"}}}}]}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"type":"object","required":["id","type"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a managed card — used wherever a card appears (the card on a card payment, or the access instrument that initiated a transaction)."},"children":[]}]}]}],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the managed card."},"type":{"type":"string","enum":["managed_cards"]},"mode":{"type":"string","enum":["prepaid","debit"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode the card was created in."},"children":[]}]}]},{"$$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":"prepaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has its own balance and can have funds transferred to or from it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has no balance of its own; it draws on its parent managed account up to a configurable spend limit."},"children":[]}]}]}]}]},"friendlyName":{"type":"string","description":"The friendly name chosen for the card."},"nameOnCard":{"type":"string","description":"The cardholder name printed on the card."},"cardBrand":{"type":"string","enum":["MASTERCARD","VISA"],"description":"The scheme of the card. Restricted to schemes supported by card payments."},"cardNumberFirstSix":{"type":"string","pattern":"^[0-9]{6}$","description":"The first six digits of the card number (BIN range)."},"cardNumberLastFour":{"type":"string","pattern":"^[0-9]{4}$","description":"The last four digits of the card number."},"linkedUserId":{"type":"string","pattern":"^[0-9]+$","description":"Identifier of the authorised user the card is assigned to. Populated only when the card has been assigned to a specific user."},"parentManagedAccountId":{"type":"string","pattern":"^[0-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 managed account this card draws funds from. Populated only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity."},"children":[]}]}]}],"required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant identifier (MID) — the acquirer-assigned code that identifies the merchant on card-scheme messages (ISO 8583 DE 42 Card Acceptor Identification Code)."},"children":[]}]}]}]},"name":{"type":"string","description":"Merchant name (DBA name)."},"nameOther":{"type":"string","description":"Alternative merchant name as supplied by the card network, when present."},"networkId":{"type":"string","description":"Identifier assigned by the acquirer or scheme to the merchant."},"categoryCode":{"type":"string","description":"ISO 18245 merchant category code (MCC)."},"description":{"type":"string","description":"Free-text description of the merchant."},"street":{"type":"string","description":"Street address of the merchant terminal."},"city":{"type":"string","description":"City of the merchant terminal."},"state":{"type":"string","description":"Subdivision (state, province, region) of the merchant terminal."},"postalCode":{"type":"string","description":"Postal code of the merchant terminal."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the merchant terminal."},"telephone":{"type":"string","description":"Merchant telephone."},"url":{"type":"string","description":"Merchant website."},"contact":{"type":"string","description":"Merchant contact (name or email of a representative, when present)."},"reference":{"type":"string","description":"Merchant-supplied reference for the transaction (the merchant's own identifier for what they billed)."},"logoUrl":{"type":"string","description":"Merchant logo URL, when available."}}}},"components/schemas/CardPaymentEvent":{"id":"components/schemas/CardPaymentEvent","kind":"json-schema","title":"CardPaymentEvent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An event in a card payment's lifecycle, lean — used "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nested"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The parent card payment provides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so the lean variants don't repeat them. Each event carries its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Four variants discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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":"AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentAuthorisationEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentSettlementEvent"},"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":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentRefundEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentOriginalCreditEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Visa OCT / Mastercard MoneySend)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standalone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — which carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentEventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CardPaymentEventType"}},"discriminator":{"propertyName":"type","mapping":{"AUTHORISATION":"#/components/schemas/CardPaymentAuthorisationEvent","SETTLEMENT":"#/components/schemas/CardPaymentSettlementEvent","REFUND":"#/components/schemas/CardPaymentRefundEvent","ORIGINAL_CREDIT":"#/components/schemas/CardPaymentOriginalCreditEvent"}}}},"components/schemas/CardPaymentEventDetail":{"id":"components/schemas/CardPaymentEventDetail","kind":"json-schema","title":"CardPaymentEventDetail","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone card payment event — same four variants as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but each row also carries the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" context ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") so embedders can render an event-centric history feed without fetching each parent card payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used as the item type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For the lean nested version (inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CardPaymentEventType"}},"discriminator":{"propertyName":"type","mapping":{"AUTHORISATION":"#/components/schemas/CardPaymentAuthorisationEventDetail","SETTLEMENT":"#/components/schemas/CardPaymentSettlementEventDetail","REFUND":"#/components/schemas/CardPaymentRefundEventDetail","ORIGINAL_CREDIT":"#/components/schemas/CardPaymentOriginalCreditEventDetail"}}}},"components/schemas/SpendLimit":{"id":"components/schemas/SpendLimit","kind":"json-schema","title":"SpendLimit","data":{"type":"object","required":["value","interval"],"properties":{"startTimestamp":{"description":"The start timestamp of the spend limit, expressed in Epoch timestamp using millisecond precision.","type":"integer","format":"int64","minimum":1},"value":{"description":"The spend limit, as amount and currency, (for the given interval).","$ref":"#/components/schemas/CurrencyAmount"},"interval":{"$ref":"#/components/schemas/SpendLimitInterval"}}}},"components/schemas/ProfileLevelSpendRules":{"id":"components/schemas/ProfileLevelSpendRules","kind":"json-schema","title":"ProfileLevelSpendRules","data":{"allOf":[{"$ref":"#/components/schemas/CommonLevelSpendRules"},{"type":"object","properties":{"authForwardingEnabled":{"type":"boolean","description":"Indicates if auth forwarding is enabled on profile level"}}}]}},"components/schemas/IdentityLevelSpendRules":{"id":"components/schemas/IdentityLevelSpendRules","kind":"json-schema","title":"IdentityLevelSpendRules","data":{"allOf":[{"$ref":"#/components/schemas/CommonLevelSpendRules"},{"type":"object","properties":{"minTransactionAmount":{"type":"integer","minimum":0,"format":"int64","description":"The minimum transaction amount, in card currency, that is allowed. If the transaction amount is less than this value, then the transaction will be declined. Omit this, or set to 0 if no maximum transaction amount is to be set."},"maxTransactionAmount":{"type":"integer","minimum":0,"format":"int64","description":"The maximum transaction amount, in card currency, that is allowed. If the transaction amount is greater than this value, then the transaction will be declined."}}}]}},"components/schemas/ExecutionTimestamp":{"id":"components/schemas/ExecutionTimestamp","kind":"json-schema","title":"ExecutionTimestamp","data":{"pattern":"^[0-9]+$","type":"string","description":"The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED."}},"components/schemas/TransactionCancelResponse":{"id":"components/schemas/TransactionCancelResponse","kind":"json-schema","title":"TransactionCancelResponse","data":{"required":["id","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction."},"state":{"type":"string","enum":["SUCCESS","ERROR"]},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the reason why the cancel operation could not be executed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be included in the response if the state is \"ERROR\"."},"children":[]}]}]},{"$$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":"\"GENERIC\": A generic error has occurred."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"TRANSACTION_NOT_SCHEDULED\": The transaction is not in state SCHEDULED."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"FORBIDDEN\": The current user is not allowed to access this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"NOT_FOUND\": The transaction does not exist."},"children":[]}]}]}]}],"enum":["GENERIC","TRANSACTION_NOT_SCHEDULED","FORBIDDEN","NOT_FOUND"]}}}},"components/schemas/ChallengeExemptionReason":{"id":"components/schemas/ChallengeExemptionReason","kind":"json-schema","title":"ChallengeExemptionReason","data":{"type":"string","enum":["LOW_VALUE","TRUSTED_BENEFICIARY"],"description":"The Reason the transaction was exempted from SCA verification"}},"components/schemas/TransactionForex":{"id":"components/schemas/TransactionForex","kind":"json-schema","title":"TransactionForex","data":{"type":"object","description":"Foreign exchange details when the transaction involved currency conversion.","properties":{"originalAmount":{"description":"The original amount in the source or merchant currency before conversion.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":"The exchange rate applied to the conversion.","$ref":"#/components/schemas/ScaledAmount"},"paddingAmount":{"description":"The forex padding amount held during authorisation.","$ref":"#/components/schemas/CurrencyAmount"},"feeAmount":{"description":"The forex markup fee amount.","$ref":"#/components/schemas/CurrencyAmount"}}}},"components/schemas/OutgoingWireTransferType":{"id":"components/schemas/OutgoingWireTransferType","kind":"json-schema","title":"OutgoingWireTransferType","data":{"type":"string","description":"The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.","enum":["SEPA","FASTER_PAYMENTS","SWIFT","RIX"]}},"components/schemas/OutgoingWireTransferRejectedInfo":{"id":"components/schemas/OutgoingWireTransferRejectedInfo","kind":"json-schema","title":"OutgoingWireTransferRejectedInfo","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional info when the outgoing wire transfer has been rejected, 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":"text","inline":true,"attributes":{"content":"SYSTEM: The wire transfer was rejected by the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: The wire transfer was rejected by the user."},"children":[]}]}]}]}],"type":"string","enum":["SYSTEM","USER"]}},"components/schemas/OutgoingWireTransferValidationOutcome":{"id":"components/schemas/OutgoingWireTransferValidationOutcome","kind":"json-schema","title":"OutgoingWireTransferValidationOutcome","data":{"type":"object","required":["category","categoryResult"],"properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE","SEPA_VERIFICATION_OF_PAYEE"]},"categoryResult":{"oneOf":[{"$ref":"#/components/schemas/UKConfirmationOfPayeeResult"},{"$ref":"#/components/schemas/SEPAVerificationOfPayeeResult"}]}}}},"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode":{"id":"components/schemas/OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode","kind":"json-schema","title":"OutgoingWireTransferUpdateBeneficiaryNameConflictSchemaErrorCode","data":{"type":"string","enum":["INVALID_STATE","CONFLICT_BENEFICIARYID_NAME","CONFLICT_EXTERNALACCOUNTID_NAME","MODEL_CONSTRAINTS_VIOLATED","NO_NAME_TO_ACCEPT"]}},"components/schemas/OutgoingWireTransferPaymentConfirmationConflictErrorCode":{"id":"components/schemas/OutgoingWireTransferPaymentConfirmationConflictErrorCode","kind":"json-schema","title":"OutgoingWireTransferPaymentConfirmationConflictErrorCode","data":{"type":"string","enum":["TRANSFER_NOT_COMPLETED"]}},"components/schemas/CorrespondentBankingOwtValidationOutcome":{"id":"components/schemas/CorrespondentBankingOwtValidationOutcome","kind":"json-schema","title":"CorrespondentBankingOwtValidationOutcome","data":{"type":"object","required":["category","categoryResult"],"properties":{"category":{"type":"string","enum":["SEPA_VERIFICATION_OF_PAYEE","UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"oneOf":[{"$ref":"#/components/schemas/SEPAVerificationOfPayeeResult"},{"$ref":"#/components/schemas/UKConfirmationOfPayeeResult"}]}}}},"components/schemas/BeneficiaryOperationBatchId":{"id":"components/schemas/BeneficiaryOperationBatchId","kind":"json-schema","title":"BeneficiaryOperationBatchId","data":{"required":["batchId","operation"],"type":"object","properties":{"batchId":{"description":"The unique identifier of a Beneficiary.","type":"string","pattern":"^[0-9]+$"},"operation":{"description":"Describes the operation that has occurred on a beneficiary batch.","$ref":"#/components/schemas/BeneficiaryBatchOperation"}}}},"components/schemas/BeneficiaryState":{"id":"components/schemas/BeneficiaryState","kind":"json-schema","title":"BeneficiaryState","data":{"type":"string","enum":["INITIALISED","INVALID","PENDING_CHALLENGE","CHALLENGE_FAILED","ACTIVE","REMOVED"]}},"components/schemas/BeneficiaryValidationFailure":{"id":"components/schemas/BeneficiaryValidationFailure","kind":"json-schema","title":"BeneficiaryValidationFailure","data":{"type":"string","enum":["INSTRUMENT_DETAILS_NOT_FOUND","BENEFICIARY_DETAILS_ALREADY_EXIST","BENEFICIARY_BELONGS_TO_SAME_IDENTITY"]}},"components/schemas/TransactionActivityItem":{"id":"components/schemas/TransactionActivityItem","kind":"json-schema","title":"TransactionActivityItem","data":{"type":"object","required":["id","type","status","amount","instrument","creationTimestamp"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction activity entry returned by the cross-instrument "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common fields are surfaced at the top level for easy filtering and sorting without inspecting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The full transaction object (Transfer, Send, OWT, CBT, IWT, CardPayment,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FeeTransaction, SystemTransaction) is available under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detailed consumption."},"children":[]}]}]}],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The transaction identifier."},"type":{"$ref":"#/components/schemas/TransactionActivityType"},"status":{"$ref":"#/components/schemas/TransactionActivityStatus"},"direction":{"$ref":"#/components/schemas/TransactionActivityDirection"},"amount":{"description":"The primary transaction amount in the instrument's currency.","$ref":"#/components/schemas/CurrencyAmount"},"instrument":{"description":"The instrument this transaction belongs to.","$ref":"#/components/schemas/InstrumentId"},"fee":{"description":"The fee linked to this transaction, if any.","$ref":"#/components/schemas/FeeSummary"},"creationTimestamp":{"type":"integer","format":"int64"},"lastUpdatedTimestamp":{"type":"integer","format":"int64"},"transaction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full transaction object. Schema matches the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/Transfer"},{"$ref":"#/components/schemas/Send"},{"$ref":"#/components/schemas/OutgoingWireTransfer"},{"$ref":"#/components/schemas/CorrespondentBankingOwt"},{"$ref":"#/components/schemas/IncomingWireTransfer"},{"$ref":"#/components/schemas/CardPayment"},{"$ref":"#/components/schemas/FeeTransaction"},{"$ref":"#/components/schemas/SystemTransaction"}]}}}},"components/schemas/CorporateKybClassification":{"id":"components/schemas/CorporateKybClassification","kind":"json-schema","title":"CorporateKybClassification","data":{"type":"object","description":"An industry/activity classification code.","properties":{"type":{"type":"string","description":"Classification scheme.","enum":["NACE","SIC","ISIC"]},"code":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":255}}}},"components/schemas/CorporateKybTaxIdentifier":{"id":"components/schemas/CorporateKybTaxIdentifier","kind":"json-schema","title":"CorporateKybTaxIdentifier","data":{"type":"object","description":"A tax identification number and its issuing country.","required":["identifier"],"properties":{"identifier":{"type":"string","maxLength":100,"description":"The tax identification number."},"country":{"type":"string","maxLength":2,"description":"Issuing country, ISO 3166-1 alpha-2."}}}},"components/schemas/CorporateKybAddress":{"id":"components/schemas/CorporateKybAddress","kind":"json-schema","title":"CorporateKybAddress","data":{"type":"object","description":"A postal address.","properties":{"streetAddress":{"type":"string","maxLength":255},"streetAddress2":{"type":"string","maxLength":255},"postalCode":{"type":"string","maxLength":50},"city":{"type":"string","maxLength":100},"state":{"type":"string","maxLength":100},"region":{"type":"string","maxLength":100},"country":{"type":"string","maxLength":2,"description":"ISO 3166-1 alpha-2."}}}},"components/schemas/CorporateKybCompanyDetails":{"id":"components/schemas/CorporateKybCompanyDetails","kind":"json-schema","title":"CorporateKybCompanyDetails","data":{"type":"object","description":"Details of an affiliated company in the ownership graph.","properties":{"name":{"type":"string","maxLength":255},"registrationNumber":{"type":"string","maxLength":180},"country":{"type":"string","maxLength":2,"description":"ISO 3166-1 alpha-2."},"registrationDate":{"type":"string","description":"YYYY-MM-DD."},"legalForm":{"type":"string","maxLength":4,"description":"ISO 20275 ELF code."},"taxIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybTaxIdentifier"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybAddress"}}}}},"components/schemas/CorporateKybIndividualDetails":{"id":"components/schemas/CorporateKybIndividualDetails","kind":"json-schema","title":"CorporateKybIndividualDetails","data":{"type":"object","description":"Details of an individual in the ownership graph.","properties":{"firstName":{"type":"string","maxLength":100},"lastName":{"type":"string","maxLength":100},"middleName":{"type":"string","maxLength":100},"maidenName":{"type":"string","maxLength":100},"birthDate":{"type":"string","description":"YYYY-MM-DD."},"birthCountry":{"type":"string","maxLength":2,"description":"ISO 3166-1 alpha-2."},"birthPlace":{"type":"string","maxLength":100},"gender":{"type":"string","enum":["MALE","FEMALE","OTHER"]},"nationalities":{"type":"array","description":"ISO 3166-1 alpha-2 codes.","items":{"type":"string","maxLength":2}},"email":{"type":"string","maxLength":255},"phoneNumber":{"type":"string","maxLength":50,"description":"E.164 format."},"taxIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybTaxIdentifier"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CorporateKybAddress"}}}}},"components/schemas/KybIndustry":{"id":"components/schemas/KybIndustry","kind":"json-schema","title":"KybIndustry","data":{"type":"string","description":"The corporate's industry, for KYB pre-population.","enum":["ACCOUNTING","AUDIT","FINANCE","PUBLIC_SECTOR_ADMINISTRATION","ART_ENTERTAINMENT","AUTO_AVIATION","BANKING_LENDING","BUSINESS_CONSULTANCY_LEGAL","CONSTRUCTION_REPAIR","EDUCATION_PROFESSIONAL_SERVICES","INFORMATION_TECHNOLOGIES","TOBACCO_ALCOHOL","GAMING_GAMBLING","MEDICAL_SERVICES","PRECIOUS_GOODS_JEWELLERY","NONGOVERNMENT_ORGANISATION","INSURANCE_SECURITY","RETAIL_WHOLESALE","TRAVEL_TOURISM","FREELANCER"]}},"components/schemas/KybSourceOfFunds":{"id":"components/schemas/KybSourceOfFunds","kind":"json-schema","title":"KybSourceOfFunds","data":{"type":"string","description":"The corporate's source of funds, for KYB pre-population.","enum":["LABOUR_CONTRACT","CIVIL_CONTRACT","RENT","FUNDS_FROM_OTHER_AUXILIARY_SOURCES","SALE_OF_MOVABLE_ASSETS","SALE_OF_REAL_ESTATE","ORDINARY_BUSINESS_ACTIVITY","DIVIDENDS","LOAN_FROM_FINANCIAL_INSTITUTIONS_CREDIT_UNIONS","LOAN_FROM_THIRD_PARTIES","SALE_OF_COMPANY_SHARES_BUSINESS","OTHER"]}},"components/schemas/DateOfBirth":{"id":"components/schemas/DateOfBirth","kind":"json-schema","title":"DateOfBirth","data":{"type":"string","format":"date","description":"The date of birth in ISO 8601 format (YYYY-MM-DD)."}},"components/schemas/ExternalAccountType":{"id":"components/schemas/ExternalAccountType","kind":"json-schema","title":"ExternalAccountType","data":{"type":"string","enum":["linked_accounts"]}},"components/schemas/AddressWithNoRequiredFields":{"id":"components/schemas/AddressWithNoRequiredFields","kind":"json-schema","title":"AddressWithNoRequiredFields","data":{"type":"object","description":"The address, with none of the separate fields being set as required.","properties":{"addressLine1":{"type":"string","description":"The first line of the address."},"addressLine2":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city of the address."},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post code associated with the address."},"state":{"maxLength":50,"type":"string","description":"The state of the address."},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of the address expressed in ISO 3166 alpha-2 format."}}}},"components/schemas/AvailableToSpend":{"id":"components/schemas/AvailableToSpend","kind":"json-schema","title":"AvailableToSpend","data":{"type":"object","properties":{"value":{"description":"The amount and currency that is available to spend, (for the given interval).","$ref":"#/components/schemas/CurrencyAmount"},"interval":{"$ref":"#/components/schemas/SpendLimitInterval"}}}},"components/schemas/SupportedUserCurrency":{"id":"components/schemas/SupportedUserCurrency","kind":"json-schema","title":"SupportedUserCurrency","data":{"enum":["JPY","BGN","CZK","DKK","HUF","PLN","RON","SEK","CHF","ISK","NOK","TRY","AUD","BRL","CAD","CNY","HKD","IDR","ILS","INR","KRW","MXN","MYR","NZD","PHP","SGD","THB","ZAR","EUR","USD","GBP"],"type":"string"}},"components/schemas/CommonLevelSpendRules":{"id":"components/schemas/CommonLevelSpendRules","kind":"json-schema","title":"CommonLevelSpendRules","data":{"type":"object","properties":{"allowedMerchantCategories":{"type":"array","maxItems":200,"items":{"type":"string"},"description":"Whitelist MCC: A list of allowed merchant category codes (MCCs). If the MCC does not match, then the transaction will be declined. If an MCC is also in the blocked list, the blocked list will take precedence."},"blockedMerchantCategories":{"type":"array","maxItems":200,"items":{"type":"string"},"description":"Blacklist MCC: A list of disallowed merchant category codes (MCCs). If the MCC matches, then the transaction will be declined. If an MCC is also in the allowed list, the blocked list will take precedence."},"allowedMerchantIds":{"type":"array","maxItems":200,"items":{"type":"string"},"description":"Whitelist Merchant Id: A list of allowed merchant IDs. If the Merchant Id does not match, then the transaction will be declined. If a Merchant Id is also provided in the blocked list, the blocked list will take precedence."},"blockedMerchantIds":{"type":"array","maxItems":200,"items":{"type":"string"},"description":"Blacklist Merchant Id: A list of disallowed merchant IDs. If the Merchant Id matches, then the transaction will be declined. If a Merchant Id is also in the allowed list, the blocked list will take precedence."},"allowedMerchantCountries":{"type":"array","maxItems":50,"items":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"description":"Whitelist Merchant Country: A list of allowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country does not match, then the transaction will be declined. If a Merchant Country is also provided in the blocked list, the blocked list will take precedence."},"blockedMerchantCountries":{"type":"array","maxItems":50,"items":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"description":"Blacklist Merchant Country: A list of disallowed merchant countries, in ISO 3166-1 alpha-2 format. If the Merchant country matches, then the transaction will be declined. If a Merchant Country is also in the allowed list, the blocked list will take precedence."},"allowContactless":{"type":"boolean","description":"Indicates if a contactless transaction is allowed on the card."},"allowAtm":{"type":"boolean","description":"Indicates if an ATM Withdrawal transaction is allowed on the card."},"allowECommerce":{"type":"boolean","description":"Indicates if an online transaction is allowed on the card."},"allowCashback":{"type":"boolean","description":"Indicates if a cashback transaction at a physical terminal is allowed on the card."},"allowCreditAuthorisations":{"type":"boolean","description":"Indicates if a the card can receive a credit transaction."},"rolloverPolicy":{"$ref":"#/components/schemas/RolloverPolicy"}}}},"components/schemas/CorrespondentBankingBankAccountDetails":{"id":"components/schemas/CorrespondentBankingBankAccountDetails","kind":"json-schema","title":"CorrespondentBankingBankAccountDetails","data":{"required":["account","financialInstitution"],"type":"object","description":"Bank account details for the originator.","properties":{"account":{"type":"string","minLength":1,"maxLength":34,"pattern":"^[a-zA-Z0-9]{1,34}$","description":"Can be either an account number or an International Bank Account Number (IBAN)."},"financialInstitution":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{8,11}$","description":"Bank Identifier Code (BIC) of the originator's financial institution."}}}},"components/schemas/CorrespondentBankingIndividualAddressAndIdInfo":{"id":"components/schemas/CorrespondentBankingIndividualAddressAndIdInfo","kind":"json-schema","title":"CorrespondentBankingIndividualAddressAndIdInfo","data":{"required":["documentType","documentNumber"],"type":"object","description":"Personal identification for an individual originator.","properties":{"documentType":{"type":"string","enum":["NATIONAL_ID","PASSPORT","TAX_ID","OTHER"],"description":"Type of personal identification document."},"documentNumber":{"type":"string","maxLength":35,"description":"Personal identification document number."}}}},"components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo":{"id":"components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo","kind":"json-schema","title":"CorrespondentBankingIndividualAddressAndBirthInfo","data":{"required":["dateOfBirth","placeOfBirth"],"type":"object","description":"Birth information for an individual originator.","properties":{"dateOfBirth":{"type":"string","format":"date","description":"Date of birth in YYYY-MM-DD format."},"placeOfBirth":{"type":"string","maxLength":140,"description":"Place of birth - city and country."}}}},"components/schemas/CorrespondentBankingBusinessAddressAndIdInfo":{"id":"components/schemas/CorrespondentBankingBusinessAddressAndIdInfo","kind":"json-schema","title":"CorrespondentBankingBusinessAddressAndIdInfo","data":{"required":["documentType","documentNumber"],"type":"object","description":"Business identification for a business originator.","properties":{"documentType":{"type":"string","enum":["LEI","REGISTRATION_NUMBER","TAX_ID","OTHER"],"description":"Type of business identification document."},"documentNumber":{"type":"string","maxLength":35,"description":"Business identification document number (e.g. LEI code, company registration number)."}}}},"components/schemas/FeeSubtype":{"id":"components/schemas/FeeSubtype","kind":"json-schema","title":"FeeSubtype","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category of fee — indicates the activity or instrument-lifecycle event the fee relates to."},"children":[]}]}]}],"enum":["fee_reversals","incoming_wire_fees","withdrawal_fees","purchase_fees","refund_fees","atm_withdrawal_fees","chargeback_fees","transfer_fees","send_fees","outgoing_wire_transfer_fees","custom_fees","other_fees","instrument_delete_fees","funds_redemption_fees","system_transaction_fees"]}},"components/schemas/FeeTransactionStatus":{"id":"components/schemas/FeeTransactionStatus","kind":"json-schema","title":"FeeTransactionStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of a fee 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":"PENDING: Fee accompanies a transaction that is still processing; it may still be cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: Fee was charged and posted to the instrument balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: Fee was cancelled before being charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REVERSED: Fee was previously charged and has been reversed."},"children":[]}]}]}]}],"enum":["PENDING","COMPLETED","CANCELLED","REVERSED"]}},"components/schemas/StatementResponseEntryTransaction":{"id":"components/schemas/StatementResponseEntryTransaction","kind":"json-schema","title":"StatementResponseEntryTransaction","data":{"type":"object","required":["id","type"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to the transaction this statement entry records. The concrete shape is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator — see the per-type variants for the available subtypes."},"children":[]}]}]}],"discriminator":{"propertyName":"type","mapping":{"card_payments":"#/components/schemas/StatementCardPaymentTransaction","transfers":"#/components/schemas/StatementTransferTransaction","sends":"#/components/schemas/StatementSendTransaction","outgoing_wire_transfers":"#/components/schemas/StatementOutgoingWireTransferTransaction","incoming_wire_transfers":"#/components/schemas/StatementIncomingWireTransferTransaction","correspondent_bank_transfers":"#/components/schemas/StatementCorrespondentBankTransferTransaction","fees":"#/components/schemas/StatementFeeTransaction","system_transactions":"#/components/schemas/StatementSystemTransaction"}},"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"type":{"$ref":"#/components/schemas/StatementResponseEntryTransactionType"}}}},"components/schemas/MerchantCounterparty":{"id":"components/schemas/MerchantCounterparty","kind":"json-schema","title":"MerchantCounterparty","data":{"type":"object","required":["name"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty for a card transaction — a merchant."},"children":[]}]}]}],"properties":{"name":{"description":"The name of the merchant.","type":"string"},"id":{"description":"The unique merchant identifier.","type":"string"},"categoryCode":{"description":"The ISO 18245 merchant category code.","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code of the merchant terminal.","type":"string"},"digitalWalletTypeUsed":{"description":"The digital wallet (if any) used to initiate the card transaction at the merchant.","$ref":"#/components/schemas/DigitalWalletType"}}}},"components/schemas/InstrumentCounterparty":{"id":"components/schemas/InstrumentCounterparty","kind":"json-schema","title":"InstrumentCounterparty","data":{"type":"object","required":["id","type"],"description":"Counterparty that is an internal platform instrument (managed account, managed card).","properties":{"id":{"description":"The unique identifier of the counterparty instrument.","type":"string","pattern":"^[0-9]+$"},"type":{"$ref":"#/components/schemas/InstrumentType"},"friendlyName":{"description":"The friendly name of the counterparty instrument.","type":"string"},"owner":{"description":"The identity that owns the counterparty instrument.","type":"object","properties":{"id":{"description":"The identity identifier.","type":"string","pattern":"^[0-9]+$"},"type":{"description":"The type of identity.","type":"string","enum":["consumers","corporates"]},"name":{"description":"The name of the identity.","type":"string"}}}}}},"components/schemas/BankAccountCounterparty":{"id":"components/schemas/BankAccountCounterparty","kind":"json-schema","title":"BankAccountCounterparty","data":{"type":"object","description":"Counterparty that is a bank account (for wire transfers).","properties":{"name":{"description":"The beneficiary or sender name.","type":"string"},"iban":{"description":"The IBAN of the bank account (SEPA/SWIFT).","type":"string"},"sortCode":{"description":"The UK sort code of the bank account (FasterPayments).","type":"string"},"accountNumber":{"description":"The UK account number of the bank account (FasterPayments).","type":"string"},"bic":{"description":"The BIC/SWIFT code of the bank (SEPA/SWIFT).","type":"string"},"bankCode":{"description":"Deprecated: legacy overloaded field carrying either the BIC or the sort code. Prefer bic/sortCode on new integrations.","type":"string"},"reference":{"description":"The sender or beneficiary reference.","type":"string"}}}},"components/schemas/StatementResponseEntryExecutingAccessInstrument":{"id":"components/schemas/StatementResponseEntryExecutingAccessInstrument","kind":"json-schema","title":"StatementResponseEntryExecutingAccessInstrument","data":{"type":"object","required":["id","type"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The access instrument that initiated the transaction. The concrete shape is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator."},"children":[]}]}]}],"discriminator":{"propertyName":"type","mapping":{"managed_cards":"#/components/schemas/CardAccessInstrument","ibans":"#/components/schemas/IbanAccessInstrument"}},"properties":{"id":{"description":"The unique identifier of the access instrument.","type":"string","pattern":"^[0-9]+$"},"type":{"$ref":"#/components/schemas/AccessInstrumentType"}}}},"components/schemas/SystemTransactionSubtype":{"id":"components/schemas/SystemTransactionSubtype","kind":"json-schema","title":"SystemTransactionSubtype","data":{"type":"string","description":"The specific kind of system-generated transaction.","enum":["account_closures","chargebacks_represented","chargebacks_won","manual_auth_expiries","negative_card_balances","balance_adjustments","lost_stolen_replacement_balance_transfers"]}},"components/schemas/DeliveryTrackingCode":{"id":"components/schemas/DeliveryTrackingCode","kind":"json-schema","title":"DeliveryTrackingCode","data":{"type":"string","description":"The delivery tracking code for tracking the physical card's delivery status. This may not always be available on the first dispatched event, and so you will receive an additional dispatched notification with the delivery tracking code populated as soon as it is available."}},"components/schemas/DeliveryTrackingMethod":{"id":"components/schemas/DeliveryTrackingMethod","kind":"json-schema","title":"DeliveryTrackingMethod","data":{"type":"string","description":"The delivery tracking method for tracking the physical card's delivery status."}},"components/schemas/DeliveryTrackingUrl":{"id":"components/schemas/DeliveryTrackingUrl","kind":"json-schema","title":"DeliveryTrackingUrl","data":{"type":"string","description":"The delivery tracking URL for tracking the physical card's delivery status."}},"components/schemas/CardPaymentAuthorisationEvent":{"id":"components/schemas/CardPaymentAuthorisationEvent","kind":"json-schema","title":"CardPaymentAuthorisationEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorisation lifecycle event — the merchant asked the bank for funds, or an existing hold was adjusted / released. No money moves until clearing. Used inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the parent card payment provides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so this lean variant doesn't repeat them. For a standalone version with that context attached, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentAuthorisationEventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","subtype","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the underlying transaction, representing the type of activity the authorisation is for. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","account_funding"]},"reversal":{"type":"boolean","description":"True when this event is a reversal of a prior authorisation in the same lifecycle (e.g. merchant void, expiry, explicit cancellation). False for originals."},"result":{"description":"Approved or declined by the issuer. Populated on originals; omitted on reversals.","$ref":"#/components/schemas/CardPaymentEventResult"},"authorisationCategory":{"description":"Pre-auth (provisional hold, will clear separately) or final auth (estimated amount equals final amount).","$ref":"#/components/schemas/AuthorisationCategory"},"authForwardingDetails":{"description":"When the card is configured for auth forwarding, the forwarding context for this event.","$ref":"#/components/schemas/CardPaymentAuthForwardingDetails"},"declineReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentDeclineReason"},"authRuleFailedReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific auth rule that caused the decline. Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declineReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH_RULE_CHECKS_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mirrors the legacy authorisation webhook's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authRuleFailedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancellationReason":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text reason for an explicit cancellation of an authorisation hold. Populated on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events driven by explicit cancellation rather than network reversal."},"children":[]}]}]}]},"transactionAmount":{"description":"The amount for this event, in the merchant's currency (ISO 8583 DE 4).","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency (ISO 8583 DE 6).","$ref":"#/components/schemas/CurrencyAmount"},"forex":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth-time FX context — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"padding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Populated on cross-currency authorisations."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentForex"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code on this scheme message (ISO 8583 DE 38). Echoed by subsequent settlement, refund, OCT messages in the same lifecycle."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred at the point-of-interaction, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentSettlementEvent":{"id":"components/schemas/CardPaymentSettlementEvent","kind":"json-schema","title":"CardPaymentSettlementEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A settlement event — money actually moves between the cardholder's account and the merchant, or back the other way. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Financial Transaction 0220 · Mastercard First Presentment 1240."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","subtype","settlementState","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"subtype":{"type":"string","description":"Card-scheme network classification of the underlying transaction being settled.","enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","account_funding"]},"reversal":{"type":"boolean","description":"True when this event reverses a prior settlement; funds return to the card. False for originals."},"settlementState":{"description":"Processing state of this settlement on the platform.","$ref":"#/components/schemas/CardPaymentSettlementState"},"transactionAmount":{"description":"The amount cleared, in the merchant's currency (ISO 8583 DE 4).","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount billed against the card, in the card's currency (ISO 8583 DE 6). May differ from any earlier authorisation due to final amount and forex movement.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":"Forex rate applied at clearing time.","$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this settlement event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentRefundEvent":{"id":"components/schemas/CardPaymentRefundEvent","kind":"json-schema","title":"CardPaymentRefundEvent","data":{"description":"A refund credited to the card, tied to an earlier purchase.","allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"reversal":{"type":"boolean","description":"True when this event reverses a prior refund (money was returned to the cardholder and is now being clawed back). False for an original refund credit."},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the refund. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["purchase_refunds","purchase_refund_reversals"]},"reasonCode":{"type":"string","description":"Network reason code accompanying the event, when provided by the scheme."},"transactionAmount":{"description":"The amount credited / reversed, in the merchant's currency.","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentOriginalCreditEvent":{"id":"components/schemas/CardPaymentOriginalCreditEvent","kind":"json-schema","title":"CardPaymentOriginalCreditEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A push credit to the card not tied to a prior purchase. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Original Credit Transaction (OCT) · Mastercard MoneySend."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"reversal":{"type":"boolean","description":"True when this event reverses a prior OCT (push credit being clawed back). False for an original push credit."},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the OCT. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["original_credit_transactions","original_credit_transaction_reversals"]},"reasonCode":{"type":"string","description":"Network reason code accompanying the event, when provided by the scheme."},"transactionAmount":{"description":"The amount credited / reversed, in the merchant's currency.","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentAuthorisationEventDetail":{"id":"components/schemas/CardPaymentAuthorisationEventDetail","kind":"json-schema","title":"CardPaymentAuthorisationEventDetail","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorisation event with parent card-payment context — used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEventDetail"},{"$ref":"#/components/schemas/CardPaymentAuthorisationEvent"},{"$ref":"#/components/schemas/CardPaymentEventContext"}]}},"components/schemas/CardPaymentSettlementEventDetail":{"id":"components/schemas/CardPaymentSettlementEventDetail","kind":"json-schema","title":"CardPaymentSettlementEventDetail","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement event with parent card-payment context — used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEventDetail"},{"$ref":"#/components/schemas/CardPaymentSettlementEvent"},{"$ref":"#/components/schemas/CardPaymentEventContext"}]}},"components/schemas/CardPaymentRefundEventDetail":{"id":"components/schemas/CardPaymentRefundEventDetail","kind":"json-schema","title":"CardPaymentRefundEventDetail","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund event with parent card-payment context — used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEventDetail"},{"$ref":"#/components/schemas/CardPaymentRefundEvent"},{"$ref":"#/components/schemas/CardPaymentEventContext"}]}},"components/schemas/CardPaymentOriginalCreditEventDetail":{"id":"components/schemas/CardPaymentOriginalCreditEventDetail","kind":"json-schema","title":"CardPaymentOriginalCreditEventDetail","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original-credit event with parent card-payment context — used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEventDetail"},{"$ref":"#/components/schemas/CardPaymentOriginalCreditEvent"},{"$ref":"#/components/schemas/CardPaymentEventContext"}]}},"components/schemas/SpendLimitInterval":{"id":"components/schemas/SpendLimitInterval","kind":"json-schema","title":"SpendLimitInterval","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time period for which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"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":"text","inline":true,"attributes":{"content":"DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day"},"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":"WEEKLY: 00:00:00 UTC Monday of current week to following Sunday 23:59:59 UTC"},"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":"MONTHLY: 1st of current calendar month to end of current calendar month"},"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":"QUARTERLY: starting from beginning of current quarter where quarters are defined as follows:"},"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":"1 January 00:00:00 UTC to 31 March 23:59:59 UTC"},"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":"1 April 00:00:00 UTC to 30 Jun 23:59:59 UTC"},"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":"1 July 00:00:00 UTC to 30 September 23:59:59 UTC"},"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":"1 October 00:00:00 UTC to 31 December 23:59:59 UTC"},"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":"YEARLY: 1 January 00:00:00 UTC of current calendar year to 31 December 23:59:59 UTC of current calendar year."},"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":"ALWAYS: This indicates that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the total amount that can be spent through the card throughout the whole lifetime of the card."},"children":[]}]}]}]}]}],"type":"string","enum":["DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","ALWAYS"]}},"components/schemas/UKConfirmationOfPayeeResult":{"id":"components/schemas/UKConfirmationOfPayeeResult","kind":"json-schema","title":"UKConfirmationOfPayeeResult","data":{"type":"object","required":["match"],"properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH","NOT_POSSIBLE"]},"reasonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the matching failed at the UK Confirmation of Payee responder:"},"children":[]}]}]},{"$$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":"ANNM: The CoP responder confirms that the account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided does not match;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBAM: The CoP responder indicates that the account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided closely matches the actual account in its records, the actual account name is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountName"},"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":"text","inline":true,"attributes":{"content":"BANM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'PERSONAL', but the CoP responder indicates that the actual account matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is actually BUSINESS;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PANM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'BUSINESS', but the CoP responder indicates that the actual account matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is actually PERSONAL;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAMM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'PERSONAL', but the CoP responder indicates that an account closely matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is BUSINESS;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAMM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'BUSINESS', but the CoP responder indicates that an account closely matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is PERSONAL;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC01: The account does not exist in the CoP responders books, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified is likely incorrect;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IVCR: The CoP responder was unable to locate an account based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondaryReference"},"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":"text","inline":true,"attributes":{"content":"ACNS: The account is not supported for CoP by the CoP responder;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OPTO: The owner of the account has opted out of CoP service by the CoP responder;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASS: The account has been switched using the Current Account Switch Service;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCNS: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is not supported at endpoint;"},"children":[]}]}]}]}],"enum":["ANNM","MBAM","BANM","PANM","BAMM","PAMM","AC01","IVCR","ACNS","OPTO","CASS","SCNS"]},"accountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CoP: Returned when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSE_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is MBAM, BAMM or PAMM"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VoP: Returned when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSE_MATCH"},"children":[]}]}]}]}}}},"components/schemas/SEPAVerificationOfPayeeResult":{"id":"components/schemas/SEPAVerificationOfPayeeResult","kind":"json-schema","title":"SEPAVerificationOfPayeeResult","data":{"type":"object","required":["match"],"properties":{"match":{"type":"string","description":"The result of the SEPA Verification of Payee check performed by the responding PSP.","enum":["MATCH","NO_MATCH","CLOSE_MATCH","NOT_POSSIBLE"]},"accountName":{"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 account holder as registered with the responding PSP."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the match result is CLOSE_MATCH to help the payer verify the payee."},"children":[]}]}]}]}}}},"components/schemas/RolloverPolicy":{"id":"components/schemas/RolloverPolicy","kind":"json-schema","title":"RolloverPolicy","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 rollover policy will dictate how Weavr handles any eventual overspending. This is possible if a merchant clears more funds than authorised, or when a merchant clears funds without authorising, resulting in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableToSpend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to go into negative. Rollover is relative to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendLimit.interval"},"children":[]}]}]}],"required":["rolloverNegative"],"properties":{"rolloverNegative":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true any overspend will keep rolling over and get deducted in the upcoming intervals until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableToSpend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is back to a positive value. Any overspend will be deducted from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableToSpend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the beginning of the next interval."},"children":[]}]}]}]}}}},"components/schemas/StatementCardPaymentTransaction":{"id":"components/schemas/StatementCardPaymentTransaction","kind":"json-schema","title":"StatementCardPaymentTransaction","data":{"description":"Reference to a card payment as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/StatementCardPaymentSubtype"}}}]}},"components/schemas/StatementTransferTransaction":{"id":"components/schemas/StatementTransferTransaction","kind":"json-schema","title":"StatementTransferTransaction","data":{"description":"Reference to a transfer as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"}]}},"components/schemas/StatementSendTransaction":{"id":"components/schemas/StatementSendTransaction","kind":"json-schema","title":"StatementSendTransaction","data":{"description":"Reference to a send as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"}]}},"components/schemas/StatementOutgoingWireTransferTransaction":{"id":"components/schemas/StatementOutgoingWireTransferTransaction","kind":"json-schema","title":"StatementOutgoingWireTransferTransaction","data":{"description":"Reference to an outgoing wire transfer as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/StatementOutgoingWireTransferSubtype"}}}]}},"components/schemas/StatementIncomingWireTransferTransaction":{"id":"components/schemas/StatementIncomingWireTransferTransaction","kind":"json-schema","title":"StatementIncomingWireTransferTransaction","data":{"description":"Reference to an incoming wire transfer as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/StatementIncomingWireTransferSubtype"}}}]}},"components/schemas/StatementCorrespondentBankTransferTransaction":{"id":"components/schemas/StatementCorrespondentBankTransferTransaction","kind":"json-schema","title":"StatementCorrespondentBankTransferTransaction","data":{"description":"Reference to a correspondent bank transfer as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/StatementCorrespondentBankTransferSubtype"}}}]}},"components/schemas/StatementFeeTransaction":{"id":"components/schemas/StatementFeeTransaction","kind":"json-schema","title":"StatementFeeTransaction","data":{"description":"Reference to a fee transaction as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/FeeSubtype"}}}]}},"components/schemas/StatementSystemTransaction":{"id":"components/schemas/StatementSystemTransaction","kind":"json-schema","title":"StatementSystemTransaction","data":{"description":"Reference to a system-generated transaction as it appears in a statement entry.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryTransaction"},{"type":"object","properties":{"subtype":{"$ref":"#/components/schemas/SystemTransactionSubtype"}}}]}},"components/schemas/DigitalWalletType":{"id":"components/schemas/DigitalWalletType","kind":"json-schema","title":"DigitalWalletType","data":{"type":"string","description":"The digital wallet type.","enum":["GOOGLE_PAY","APPLE_PAY","MERCHANT_TOKEN"]}},"components/schemas/CardAccessInstrument":{"id":"components/schemas/CardAccessInstrument","kind":"json-schema","title":"CardAccessInstrument","data":{"description":"An access instrument that is a managed card (e.g. a debit-mode card initiating a transaction on its parent managed account).","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryExecutingAccessInstrument"},{"type":"object","properties":{"friendlyName":{"description":"The friendly name of the card.","type":"string"},"cardBrand":{"description":"The card brand (e.g. VISA, MASTERCARD).","type":"string"},"cardNumberFirstSix":{"description":"The first six digits of the card number.","type":"string"},"cardNumberLastFour":{"description":"The last four digits of the card number.","type":"string"}}}]}},"components/schemas/IbanAccessInstrument":{"id":"components/schemas/IbanAccessInstrument","kind":"json-schema","title":"IbanAccessInstrument","data":{"description":"An access instrument that is an IBAN attached to a managed account.","allOf":[{"$ref":"#/components/schemas/StatementResponseEntryExecutingAccessInstrument"},{"type":"object","properties":{"friendlyName":{"description":"The friendly name of the access instrument.","type":"string"},"handle":{"description":"The IBAN or account number.","type":"string"}}}]}},"components/schemas/CardPaymentEventResult":{"id":"components/schemas/CardPaymentEventResult","kind":"json-schema","title":"CardPaymentEventResult","data":{"type":"string","description":"Outcome of an authorisation event.","enum":["APPROVED","DECLINED"]}},"components/schemas/AuthorisationCategory":{"id":"components/schemas/AuthorisationCategory","kind":"json-schema","title":"AuthorisationCategory","data":{"type":"string","description":"The category of the authorisation.","enum":["PRE_AUTH","FINAL_AUTH"]}},"components/schemas/CardPaymentAuthForwardingDetails":{"id":"components/schemas/CardPaymentAuthForwardingDetails","kind":"json-schema","title":"CardPaymentAuthForwardingDetails","data":{"type":"object","description":"Details of auth-forwarding handling on the authorisation.","properties":{"triggered":{"type":"boolean","description":"True if auth forwarding was triggered for this authorisation."},"decisionOutcome":{"description":"Default decision applied if the innovator did not respond in time.","$ref":"#/components/schemas/CardPaymentAuthForwardingDecisionOutcome"},"innovatorTimedOut":{"type":"boolean","description":"True if the innovator failed to respond within the configured timeout and the default decision was applied."}}}},"components/schemas/CardPaymentDeclineReason":{"id":"components/schemas/CardPaymentDeclineReason","kind":"json-schema","title":"CardPaymentDeclineReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason an authorisation was declined; populated only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result = DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mirrors the legacy authorisation webhook's decline reason values."},"children":[]}]}]}],"enum":["NO_REASON","PHYSICAL_NOT_ACTIVATED","INSUFFICIENT_BALANCE","CVV_CHECKS_FAILED","CVV_RETRIES_EXCEEDED","CARD_STATUS_NOT_ALLOWED","PIN_CHECKS_FAILED","PIN_RETRIES_EXCEEDED","CARD_EXPIRY_CHECKS_FAILED","AVS_CHECKS_FAILED","ATM_WITHDRAWAL_LIMIT_EXCEEDED","SCA_REQUIRED","AUTH_RULE_CHECKS_FAILED","TRANSACTION_NOT_PERMITTED","TIMEOUT","SINGLE_SPEND","EXCEEDS_PER_TRANSACTION_LIMIT"]}},"components/schemas/CardPaymentForex":{"id":"components/schemas/CardPaymentForex","kind":"json-schema","title":"CardPaymentForex","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth-time FX context: the rate applied at authorisation and the cushion blocked to cater for rate movement before settlement. Surfaced as a pair on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events only — on settlement/refund/oct the rate sits at the event top-level (it modifies that event's amounts directly) and padding has already been absorbed or released at clearing time."},"children":[]}]}]}],"properties":{"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at authorisation time. Populated on cross-currency authorisations."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"padding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extra amount blocked at authorisation time to cater for currency fluctuation between auth and settlement. Already included in the event's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; surfaced separately so the embedder can show the cardholder how much of the charge is the FX cushion. Released or absorbed at clearing time."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"}}}},"components/schemas/CardPaymentFee":{"id":"components/schemas/CardPaymentFee","kind":"json-schema","title":"CardPaymentFee","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee accrued on a specific card payment event. Discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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":"PLATFORM_FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentPlatformFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — fee charged by the platform; points at the underlying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"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":"FOREX_FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentForexFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — forex padding + forex fee captured at authorisation on a cross-currency event."},"children":[]}]}]}]}],"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CardPaymentFeeType"}},"discriminator":{"propertyName":"type","mapping":{"PLATFORM_FEE":"#/components/schemas/CardPaymentPlatformFee","FOREX_FEE":"#/components/schemas/CardPaymentForexFee"}}}},"components/schemas/CardPaymentSettlementState":{"id":"components/schemas/CardPaymentSettlementState","kind":"json-schema","title":"CardPaymentSettlementState","data":{"type":"string","description":"Processing state of a settlement event at the scheme.","enum":["PENDING","COMPLETED"]}},"components/schemas/CardPaymentEventContext":{"id":"components/schemas/CardPaymentEventContext","kind":"json-schema","title":"CardPaymentEventContext","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent card-payment context attached to standalone ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*EventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") variants so each event row returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is self-contained — no need to fetch the parent card payment separately to render a history entry."},"children":[]}]}]}],"required":["cardPaymentId","card","merchant"],"properties":{"cardPaymentId":{"type":"string","pattern":"^[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this event belongs to."},"children":[]}]}]}]},"card":{"$ref":"#/components/schemas/Card"},"merchant":{"$ref":"#/components/schemas/Merchant"}}}},"components/schemas/StatementCardPaymentSubtype":{"id":"components/schemas/StatementCardPaymentSubtype","kind":"json-schema","title":"StatementCardPaymentSubtype","data":{"type":"string","description":"Subtype of a card payment statement entry.","enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","purchase_refund_reversals","original_credit_transaction_reversals","cash_withdrawal_reversals","purchase_refunds","purchase_reversals","original_credit_transactions","first_chargebacks","first_chargeback_reversals","first_representments","first_representment_reversals","second_chargebacks","second_chargeback_reversals","second_representments","arbitration_chargebacks"]}},"components/schemas/StatementOutgoingWireTransferSubtype":{"id":"components/schemas/StatementOutgoingWireTransferSubtype","kind":"json-schema","title":"StatementOutgoingWireTransferSubtype","data":{"type":"string","description":"Subtype of an outgoing wire transfer statement entry.","enum":["redemptions","returns"]}},"components/schemas/StatementIncomingWireTransferSubtype":{"id":"components/schemas/StatementIncomingWireTransferSubtype","kind":"json-schema","title":"StatementIncomingWireTransferSubtype","data":{"type":"string","description":"Subtype of an incoming wire transfer statement entry.","enum":["fundings"]}},"components/schemas/StatementCorrespondentBankTransferSubtype":{"id":"components/schemas/StatementCorrespondentBankTransferSubtype","kind":"json-schema","title":"StatementCorrespondentBankTransferSubtype","data":{"type":"string","description":"Subtype of a correspondent bank transfer statement entry.","enum":["returns"]}},"components/schemas/CardPaymentAuthForwardingDecisionOutcome":{"id":"components/schemas/CardPaymentAuthForwardingDecisionOutcome","kind":"json-schema","title":"CardPaymentAuthForwardingDecisionOutcome","data":{"type":"string","description":"Default decision applied if the innovator does not respond in time during auth-forwarding.","enum":["APPROVE","DECLINE"]}},"components/schemas/CardPaymentFeeType":{"id":"components/schemas/CardPaymentFeeType","kind":"json-schema","title":"CardPaymentFeeType","data":{"type":"string","enum":["PLATFORM_FEE","FOREX_FEE"]}},"components/schemas/CardPaymentPlatformFee":{"id":"components/schemas/CardPaymentPlatformFee","kind":"json-schema","title":"CardPaymentPlatformFee","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee charged by the platform on this card payment event (a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posted against the cardholder's instrument). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" points at the underlying fee transaction, retrievable in full via the Transaction Activity API."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentFee"},{"type":"object","required":["id","subtype","amount"],"properties":{"id":{"type":"string","pattern":"^[0-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 underlying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"subtype":{"description":"Category of fee.","$ref":"#/components/schemas/CardPaymentFeeSubtype"},"amount":{"description":"Fee amount, in the currency of the instrument the fee was applied to.","$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/CardPaymentForexFee":{"id":"components/schemas/CardPaymentForexFee","kind":"json-schema","title":"CardPaymentForexFee","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex fee charged on a cross-currency event. Already included in the event's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — surfaced here so the embedder can show the cardholder how much of the charge was the forex fee."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentFee"},{"type":"object","properties":{"amount":{"description":"The forex fee charged on this event, in the currency of the instrument the fee was applied to.","$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/CardPaymentFeeSubtype":{"id":"components/schemas/CardPaymentFeeSubtype","kind":"json-schema","title":"CardPaymentFeeSubtype","data":{"type":"string","description":"The category of a platform fee accrued on a card payment event. Restricted to subtypes that can fire on card payments.","enum":["purchase_fees","refund_fees","atm_withdrawal_fees","withdrawal_fees","chargeback_fees","fee_reversals","custom_fees","other_fees"]}},"schema_359":{"kind":"json-schema","data":{"type":"string"},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"required":["profileId","rootUser","company","ipAddress","baseCurrency"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"rootUser":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The root user of the Corporate, provided in one of two ways:"},"children":[]}]}]},{"$$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 full details of the root user, when creating a new root user. The root user needs to be a director or a legal representative of the corporate that is being onboarded - this user cannot be deactivated. Root users need to verify their email address and mobile number, as well as complete KYC as part of the Corporate's due diligence process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of an existing user, when linking a root user that has already been created to this new identity. In this case the user's password is already set and does not need to be set again."},"children":[]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/CreateCorporateRootUser"},{"$ref":"#/components/schemas/CreateCorporateRootUserId"}]},"company":{"required":["name","type","registrationCountry"],"type":"object","description":"The details associated with the company being on-boarded. The details provided need to match exactly with the details provided during KYB. ","properties":{"type":{"$ref":"#/components/schemas/CompanyType"},"businessAddress":{"$ref":"#/components/schemas/Address"},"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The registration number of the company."},"registrationCountry":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The country of company registration, in ISO 3166 alpha-2 format."}}},"industry":{"$ref":"#/components/schemas/Industry"},"sourceOfFunds":{"$ref":"#/components/schemas/CorporateSourceOfFunds"},"sourceOfFundsOther":{"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 source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}],"deprecated":true},"acceptedTerms":{"type":"boolean","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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the corporate root user has accepted the terms and conditions."},"children":[]}]}]}],"deprecated":true},"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the corporate user doing the registration."},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"feeGroup":{"type":"string","description":"Fee groups allow the possibility to charge different fees to users under the same profile. If fee groups are not required, ignore this field."}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"object","properties":{"request-ref":{"type":"string","description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query."}},"required":["request-ref"]},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"maxLength":255,"type":"string","description":"When present helps to identify and fix the problem."},"syntaxErrors":{"$ref":"#/components/schemas/SyntaxError"}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSUFFICIENT_PERMISSIONS"]}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_MODEL_CONSTRAINTS_VIOLATED","PROFILE_NOT_FOUND","PROFILE_INACTIVE","ROOT_EMAIL_NOT_UNIQUE","CURRENCY_UNSUPPORTED","FEE_GROUP_INVALID","COUNTRY_INVALID","MOBILE_OR_COUNTRY_CODE_INVALID","COUNTRY_UNSUPPORTED","ROOT_USER_INACTIVE","ROOT_EMAIL_NOT_VERIFIED","PROFILE_MISMATCH","COMPANY_TYPE_UNSUPPORTED","EMAIL_DOMAIN_NOT_ALLOWED"]}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","properties":{"request-ref":{"type":"string","description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query."},"x-ratelimit-limit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20, 10;w=60, 20;w=3600, 200;w=86400"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first number (20) is the limit that has been exceeded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The remaining numbers are the limits that are in force, with 'w' meaning 'window in seconds'. In this example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20;w=3600"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was exceeded. 20 calls in 3600secs (1hr)"},"children":[]}]}]}]},"x-ratelimit-reset":{"minimum":0,"type":"integer","format":"int32","description":"The number of seconds until the window is reset."}},"required":["request-ref","x-ratelimit-limit","x-ratelimit-reset"]},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"string","maxLength":100},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_SUPPORTED","INVALID_REF","INVALID_DATA","SIGNATORY_MUST_BE_ROOT","KYB_ALREADY_STARTED"]}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_SUPPORTED","INVALID_REF","INVALID_DATA"]}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_SUPPORTED","INVALID_REF","INVALID_DATA","KYB_ALREADY_STARTED"]}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["NOT_SUPPORTED","DOCUMENT_TOO_LARGE","UNSUPPORTED_DOCUMENT_FORMAT","INVALID_DATA","KYB_ALREADY_STARTED"]}}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"required":["profileId","rootUser","ipAddress"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"rootUser":{"required":["name","surname","email","mobile","dateOfBirth","address"],"type":"object","description":"The root user represents the identity.\n\nRoot users need to verify their email address and mobile number, as well as complete KYC, as part of the Consumer's due diligence process.\n","properties":{"name":{"maxLength":50,"type":"string","description":"The first name of the root user."},"surname":{"maxLength":50,"type":"string","description":"The last name of the root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the consumer root user.","$ref":"#/components/schemas/Date"},"occupation":{"$ref":"#/components/schemas/Occupation"},"address":{"description":"Address of the consumer root user.","$ref":"#/components/schemas/AddressWithCountryRequired"},"placeOfBirth":{"type":"string","description":"Place of birth of the consumer root user."},"nationality":{"description":"Nationality of the root user, in ISO 3166 alpha-2 format.\"","$ref":"#/components/schemas/Nationality"},"tag":{"description":"Tag to be assigned to the consumer root user.","$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}},"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the user doing the registration."},"acceptedTerms":{"type":"boolean","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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the consumer has accepted the terms and conditions."},"children":[]}]}]}],"deprecated":true},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"feeGroup":{"type":"string","description":"The fee group which the consumer is bound to. Fee groups provide the possibility of different fees to users under the same profile. If fee groups are not required, ignore this field."},"sourceOfFunds":{"$ref":"#/components/schemas/ConsumerSourceOfFunds"},"sourceOfFundsOther":{"deprecated":true,"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 source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}]}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_MODEL_CONSTRAINTS_VIOLATED","PROFILE_NOT_FOUND","PROFILE_INACTIVE","ROOT_EMAIL_NOT_UNIQUE","CURRENCY_UNSUPPORTED","FEE_GROUP_INVALID","COUNTRY_INVALID","MOBILE_OR_COUNTRY_CODE_INVALID","COUNTRY_UNSUPPORTED","EMAIL_DOMAIN_NOT_ALLOWED","CONSUMER_ALREADY_EXISTS"]}}},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"required":["email","name","surname"],"type":"object","properties":{"name":{"minLength":1,"maxLength":50,"type":"string","description":"The first name of the user."},"surname":{"minLength":1,"maxLength":50,"type":"string","description":"The last name of the user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"countryOfResidence":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserPredefinedRole"},"description":"Optional roles to assign to the user. For a full description of the permissions associated with each role, see our product documentation."}}},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STEP_UP_REQUIRED"]}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_UNIQUE","MOBILE_OR_COUNTRY_CODE_INVALID","EMAIL_DOMAIN_NOT_ALLOWED","COUNTRY_OF_RESIDENCE_INVALID","KYB_MISSING","PROFILE_MISMATCH","ROLE_NOT_FOUND","CANNOT_MODIFY_OWN_ROLES","ADMIN_ROLE_REMOVAL_NOT_ALLOWED"]}}},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"minimum":0,"type":"integer","format":"int32"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"maximum":100,"minimum":1,"type":"integer","format":"int32"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Email"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/UserPredefinedRole"}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","properties":{"users":{"type":"array","description":"The list of users matching the criteria specified.","items":{"$ref":"#/components/schemas/User"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"$ref":"#/components/schemas/UserId"},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"minLength":1,"maxLength":50,"type":"string","description":"The first name of the user."},"surname":{"minLength":1,"maxLength":50,"type":"string","description":"The last name of the user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserPredefinedRole"},"description":"Optional roles to assign to the user. This uses overwrite behaviour - roles included in this list will be assigned, and roles not included will be unassigned. Users cannot update their own roles. For a full description of the permissions associated to each role, see our product documentation."}}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_UNIQUE","MOBILE_OR_COUNTRY_CODE_INVALID","MOBILE_NO_CHANGE_LIMIT_EXCEEDED","TOO_FREQUENT_EMAIL_CHANGES","EMAIL_DOMAIN_NOT_ALLOWED","MOBILE_CHANGE_NOT_ALLOWED","UNSUPPORTED_CURRENCY","ROLE_NOT_FOUND","CANNOT_MODIFY_OWN_ROLES","ADMIN_ROLE_REMOVAL_NOT_ALLOWED","ROOT_USER_ALREADY_VERIFIED"]}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"integer","minimum":0},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["IDENTITY_TYPE_NOT_SUPPORTED"]}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVITE_ALREADY_CONSUMED"]}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"required":["inviteCode"],"type":"object","properties":{"inviteCode":{"$ref":"#/components/schemas/Nonce"}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVITE_OR_INVITE_CODE_INVALID"]}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"required":["inviteCode","password"],"type":"object","properties":{"inviteCode":{"$ref":"#/components/schemas/Nonce"},"password":{"$ref":"#/components/schemas/SensitivePassword"},"mobile":{"$ref":"#/components/schemas/Mobile","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional mobile number for the user. If provided, the user's mobile is set/replaced as part of consuming the invite. The new number is left unverified — it must be enrolled afterwards."},"children":[]}]}]}]}}},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVITE_OR_INVITE_CODE_INVALID","UNRESOLVED_IDENTITY","PASSWORD_ALREADY_USED","PASSWORD_PROFILE_NOT_CONFIGURED_FOR_CREDENTIAL_TYPE","PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE","PASSWORD_KEY_ALREADY_IN_USE","PASSWORD_ALREADY_CREATED","INVALID_PASSWORD"]}}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"required":["email"],"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"}}},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_FOUND"]}}},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"required":["email","verificationCode"],"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"verificationCode":{"$ref":"#/components/schemas/VerificationCode"}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["VERIFICATION_CODE_INVALID"]}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"required":["email","password"],"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"password":{"$ref":"#/components/schemas/SensitivePassword"}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorisation token (valid for 5 minutes from last activity) identifying the user to be used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authorization header for secured operations."},"children":[]}]}]}]},"tokenType":{"$ref":"#/components/schemas/TokenType"},"identity":{"description":"The identity to which the logged-in user belongs to.","$ref":"#/components/schemas/IdentityId"},"credentials":{"description":"The unique identifier for the logged-in user.","$ref":"#/components/schemas/CredentialId"}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"object","properties":{"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Temporary authorisation token required to initiate the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"passwordUpdate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"required":["email"],"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"identity":{"$ref":"#/components/schemas/IdentityId"}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","properties":{"challengeId":{"type":"string","description":"The unique identifier of a Biometric challenge."}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_REGISTERED","CHANNEL_NOT_SUPPORTED"]}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string","description":"The logout url for third party auth providers."}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SCAOtpChannel"},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","MOBILE_NUMBER_INVALID","MOBILE_COUNTRY_NOT_SUPPORTED","RETRY_IN_15SEC","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"required":["verificationCode"],"type":"object","properties":{"verificationCode":{"description":"The code received by the user on the device.","$ref":"#/components/schemas/Nonce"}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","ONE_CHALLENGE_LIMIT_REMAINING","CHALLENGE_LIMIT_EXCEEDED","ALREADY_VERIFIED"]}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SCAPushChannel"},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The challenge id."}}},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"required":["resourceType","resourceIds"],"type":"object","properties":{"resourceType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource type that the subsequent Ids pertain to. Note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_account_declaration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be performed by a logged in Root User."},"children":[]}]}]}],"$ref":"#/components/schemas/MultipleSCAResourceType"},"resourceIds":{"type":"array","description":"Can be used with a single or a list of resource Ids. A resource Id is the unique identifier of the resource type that was provided in the response when the resource (such as a transaction) was created.","items":{"type":"string","pattern":"^[0-9]{1,}$"}}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"object","properties":{"scaChallengeId":{"$ref":"#/components/schemas/Id"}}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"STATE_INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The operation no longer requires additional verification, it was either cancelled or completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected cannot be used to verify this type of operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_REGISTERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected must be enrolled to receive one-time passwords before it can be used to verify this type of operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETRY_IN_15_SECS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The endpoint can be called again in 15 seconds. Once called successfully, a new SMS will be sent (with a different OTP to the original SMS)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHALLENGE_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No more SMS OTPs can be requested. If verification was not completed, the original action must be started again from the beginning."},"children":[]}]}]}]}],"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","RETRY_IN_15SEC","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"required":["verificationCode","resourceType"],"type":"object","properties":{"verificationCode":{"description":"The code received by the user on the device.","$ref":"#/components/schemas/Nonce"},"resourceType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource type that the subsequent Ids pertain to. Note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_account_declaration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be performed by a logged in Root User."},"children":[]}]}]}],"$ref":"#/components/schemas/MultipleSCAResourceType"}}},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","CHALLENGE_LIMIT_EXCEEDED","ONE_CHALLENGE_LIMIT_REMAINING"]}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"required":["password"],"type":"object","properties":{"password":{"$ref":"#/components/schemas/SensitivePassword"}}},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"object","properties":{"passwordInfo":{"$ref":"#/components/schemas/PasswordInfo"},"token":{"type":"string","description":"The authorisation token to be used in the Authorization header for secured operations."}}},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNRESOLVED_IDENTITY","PASSWORD_PROFILE_NOT_CONFIGURED_FOR_CREDENTIAL_TYPE","PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE","PASSWORD_KEY_ALREADY_IN_USE","PASSWORD_ALREADY_CREATED"]}}},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"required":["oldPassword","newPassword"],"type":"object","properties":{"oldPassword":{"$ref":"#/components/schemas/SensitivePassword"},"newPassword":{"$ref":"#/components/schemas/SensitivePassword"}}},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PASSWORD_ALREADY_USED","PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE","PASSWORD_INCORRECT"]}}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNRESOLVED_IDENTITY","PASSWORD_PROFILE_NOT_CONFIGURED_FOR_CREDENTIAL_TYPE","PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE"]},"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every complexity rule the submitted password failed, so all failures can be surfaced in one response. Populated only for PASSWORD_TOO_SHORT, PASSWORD_TOO_LONG and PASSWORD_TOO_SIMPLE; empty for profile-resolution errors (UNRESOLVED_IDENTITY, PASSWORD_PROFILE_NOT_CONFIGURED_FOR_CREDENTIAL_TYPE)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/PasswordValidateComplexityIssue"}}}},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["MULTIPLE_ACCOUNTS_FOUND","ACCOUNT_NOT_FOUND"]}}},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"required":["email","nonce","newPassword"],"type":"object","properties":{"nonce":{"$ref":"#/components/schemas/Nonce"},"email":{"$ref":"#/components/schemas/Email"},"newPassword":{"$ref":"#/components/schemas/SensitivePassword"}}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVALID_NONCE_OR_EMAIL","PASSWORD_ALREADY_USED","PASSWORD_TOO_SHORT","PASSWORD_TOO_LONG","PASSWORD_TOO_SIMPLE","PASSWORD_INCORRECT","PASSWORD_NOT_SET"]}}},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"object","properties":{"factors":{"type":"array","description":"The list of challenge types the logged-in user is enrolled on.","items":{"$ref":"#/components/schemas/SCAFactor"}}}},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_SUPPORTED","CHANNEL_ALREADY_REGISTERED","MOBILE_NUMBER_NOT_AVAILABLE","MOBILE_NUMBER_INVALID","MOBILE_COUNTRY_NOT_SUPPORTED","CREDENTIALS_INACTIVE","TYPE_DOES_NOT_SUPPORT_ENROLMENT"]}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_SUPPORTED","CHANNEL_ALREADY_REGISTERED","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","CREDENTIALS_INACTIVE","CHALLENGE_LIMIT_EXCEEDED","ONE_CHALLENGE_LIMIT_REMAINING","STATE_INVALID","TYPE_DOES_NOT_SUPPORT_ENROLMENT"]}}},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AuthSCAPushChannel"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STEP_UP_REQUIRED","ACCESS_TOKEN_REQUIRED","INSUFFICIENT_PERMISSIONS"]}}},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_READY","CHANNEL_ALREADY_REGISTERED","MOBILE_NUMBER_NOT_AVAILABLE","CHALLENGE_LIMIT_EXCEEDED","PASSCODE_NOT_SET","ENROLMENT_LIMIT_EXCEEDED","MOBILE_COUNTRY_NOT_SUPPORTED","TYPE_DOES_NOT_SUPPORT_ENROLMENT"]}}},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_REGISTERED","CREDENTIALS_INACTIVE"]}}},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"required":["identity"],"type":"object","properties":{"identity":{"$ref":"#/components/schemas/IdentityId"},"clientAssertion":{"description":"Generated using the certificate linked to the Delegated API Client. This feature is available only to customers that have been enabled with delegation functionality.","type":"string"},"token":{"description":"A short-lived one-time token to be exchanged for an access token. This token is used for identity verification and authorisation purposes.","type":"string"}}},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"object","properties":{"token":{"type":"string"},"identity":{"description":"The identity to which the logged-in user belongs to.","$ref":"#/components/schemas/IdentityId"},"credentials":{"description":"The unique identifier for the logged-in user.","$ref":"#/components/schemas/CredentialId"},"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 token status, 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":"text","inline":true,"attributes":{"content":"STANDARD: it is a standard token."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STEPPED_UP: it is a stepped up token."},"children":[]}]}]}]}],"enum":["STANDARD","STEPPED_UP"]}}},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/Tag"},"industry":{"$ref":"#/components/schemas/Industry"},"sourceOfFunds":{"$ref":"#/components/schemas/CorporateSourceOfFunds"},"sourceOfFundsOther":{"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":"Description of source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}]},"companyBusinessAddress":{"$ref":"#/components/schemas/Address"},"feeGroup":{"type":"string","description":"The fee group which the Corporate will be bound to. Do not specify this if you are not using fee groups."},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"name":{"maxLength":20,"pattern":"^[^0-9~!@#$%^*()_+={}\\|:;,<>/?]*$","type":"string","description":"The first name of the Corporate root user."},"surname":{"maxLength":20,"pattern":"^[^0-9~!@#$%^*()_+={}\\|:;,<>/?]*$","type":"string","description":"The last name of the Corporate root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"resetMobileCounter":{"type":"boolean"},"userTag":{"description":"The tag to be assigned to the root user.","$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["FEE_GROUP_INVALID","COUNTRY_INVALID","EMAIL_NOT_UNIQUE","ROOT_USER_ALREADY_VERIFIED","COUNTRY_UNSUPPORTED","MOBILE_OR_COUNTRY_CODE_INVALID","MOBILE_NO_CHANGE_LIMIT_EXCEEDED","TOO_FREQUENT_EMAIL_CHANGES","EMAIL_DOMAIN_NOT_ALLOWED","MOBILE_CHANGE_NOT_ALLOWED","UNSUPPORTED_CURRENCY","TERMINATION_DATE_IN_PAST"]}}},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"required":["reference"],"type":"object","properties":{"reference":{"type":"string","pattern":"^[0-9]+$","description":"The reference required to initialise the KYB UI Component."}}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["KYB_ALREADY_APPROVED","KYB_PERMANENTLY_REJECTED","KYB_PENDING_REVIEW","EMAIL_UNVERIFIED","MANAGED_ONBOARDING_PENDING"]}}},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"object","properties":{"kybStatus":{"deprecated":true,"description":"The effective due diligence status of the logged-in corporate user. Deprecated in favour of corporateKybStatus.","$ref":"#/components/schemas/KyiStatus"},"ongoingKybStatus":{"deprecated":true,"description":"The ongoing due diligence status of the logged-in corporate user. Deprecated in favour of corporateKybStatus.","$ref":"#/components/schemas/KyiStatus"},"corporateKybStatus":{"description":"The Corporate KYB Status for the corporate's regulatory FI. Indicates whether the corporate can use the FI service.","$ref":"#/components/schemas/CorporateKybStatusValue"},"kybRuns":{"description":"The KYB Runs of the corporate, one per verification attempt against a regulatory FI.","type":"array","items":{"$ref":"#/components/schemas/KybRun"}}}},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/Tag"},"name":{"maxLength":20,"pattern":"^[^0-9~!@#$%^*()_+={}\\|:;,<>/?]*$","type":"string","description":"The first name of the Consumer root user."},"surname":{"maxLength":20,"pattern":"^[^0-9~!@#$%^*()_+={}\\|:;,<>/?]*$","type":"string","description":"The last name of the Consumer root user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the consumer root user.","$ref":"#/components/schemas/Date"},"address":{"description":"Address of the consumer root user.","$ref":"#/components/schemas/AddressWithCountryRequired"},"feeGroup":{"type":"string","description":"The fee group which the consumer will be bound to. Do not specify this if you are not using fee groups."},"baseCurrency":{"$ref":"#/components/schemas/Currency"},"occupation":{"$ref":"#/components/schemas/Occupation"},"sourceOfFunds":{"$ref":"#/components/schemas/ConsumerSourceOfFunds"},"sourceOfFundsOther":{"deprecated":true,"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 source of funds in case "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was chosen."},"children":[]}]}]}]},"placeOfBirth":{"type":"string","description":"The place of birth of the consumer root user."},"nationality":{"description":"Nationality of the consumer root user, in ISO 3166 alpha-2 format.","$ref":"#/components/schemas/Nationality"},"resetMobileCounter":{"type":"boolean"},"userTag":{"description":"The tag to be assigned to the root user.","$ref":"#/components/schemas/Tag"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"}}},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["FEE_GROUP_INVALID","COUNTRY_INVALID","CONSUMER_VERIFIED","EMAIL_NOT_UNIQUE","MOBILE_OR_COUNTRY_CODE_INVALID","COUNTRY_UNSUPPORTED","MOBILE_NO_CHANGE_LIMIT_EXCEEDED","TOO_FREQUENT_EMAIL_CHANGES","EMAIL_DOMAIN_NOT_ALLOWED","MOBILE_CHANGE_NOT_ALLOWED","TERMINATION_DATE_IN_PAST"]}}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"object","properties":{"kycLevel":{"$ref":"#/components/schemas/KycLevel","description":"The KYC level that the consumer will be assigned to, which determines the due diligence details that the user will need to provide."},"prefillDetails":{"description":"List of KYC details to be prefilled for the consumer.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"required":["reference","kycLevel"],"type":"object","properties":{"reference":{"type":"string","pattern":"^[0-9]+$","description":"The reference used to initialise the KYC UI Component."},"kycLevel":{"$ref":"#/components/schemas/KycLevel","description":"The KYC level assigned to the consumer."}}},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["KYC_ALREADY_APPROVED","KYC_PENDING_REVIEW","KYC_REJECTED","EMAIL_UNVERIFIED"]}}},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","required":["fullDueDiligence","ongoingFullDueDiligence"],"properties":{"fullDueDiligence":{"description":"The status of the Due Diligence for the consumer.","$ref":"#/components/schemas/KyiStatus"},"kycLevel":{"description":"The customer's level of due diligence.","$ref":"#/components/schemas/KycLevel"},"ongoingFullDueDiligence":{"description":"The status of the ongoing Due Diligence process for the consumer","$ref":"#/components/schemas/KyiStatus"},"ongoingKycLevel":{"description":"The level of due diligence of the ongoing KYC process.","$ref":"#/components/schemas/KycLevel"}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_FOUND","ALREADY_VERIFIED","EMAIL_NOT_UNIQUE"]}}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["VERIFICATION_CODE_INVALID","EMAIL_NOT_UNIQUE"]}}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["USER_ALREADY_LINKED_TO_IDENTITY","CREDENTIAL_NOT_FOUND","KYB_MISSING","PROFILE_MISMATCH","EMAIL_DOMAIN_NOT_ALLOWED"]}}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_VERIFIED","MOBILE_NOT_VERIFIED","KYC_ALREADY_APPROVED","KYC_PENDING_REVIEW","KYC_REJECTED","KYB_IDENTITY_NOT_APPROVED"]}}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"required":["beneficiaries"],"type":"object","properties":{"tag":{"$ref":"#/components/schemas/Tag"},"beneficiaries":{"type":"array","description":"The object representing the beneficiaries' details.","items":{"$ref":"#/components/schemas/BasicBeneficiary"}}}},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","pattern":"^[0-9]+$"}},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"beneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/Beneficiary"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"required":["beneficiaryIds"],"type":"object","properties":{"beneficiaryIds":{"type":"array","description":"A list of Beneficiary Ids.","minItems":1,"items":{"type":"string","pattern":"^[0-9]+$"}}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/BeneficiaryBatchState"}},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/BeneficiaryBatchOperation"}},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"object","properties":{"batches":{"type":"array","items":{"$ref":"#/components/schemas/BeneficiaryBatch"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"STATE_INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The operation no longer requires additional verification, it was either cancelled or completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected cannot be used to verify this type of operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_REGISTERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected must be enrolled to receive one-time passwords before it can be used to verify this type of operation."},"children":[]}]}]}]}],"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED"]}}},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","ONE_CHALLENGE_LIMIT_REMAINING","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ProfileId"},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"minLength":1,"maxLength":50,"type":"string"},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/InstrumentState"}},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/BlockedReason"}},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/DestroyedReason"}},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Currency"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"object","properties":{"accounts":{"description":"The filtered managed accounts list.","type":"array","items":{"$ref":"#/components/schemas/ManagedAccount"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"required":["profileId","friendlyName","currency"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"friendlyName":{"type":"string","minLength":1,"maxLength":50,"description":"The friendly name to be given to the managed account."},"currency":{"$ref":"#/components/schemas/Currency"},"tag":{"$ref":"#/components/schemas/Tag"},"lowBalanceThreshold":{"$ref":"#/components/schemas/AccountLowBalanceThreshold"}}},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_NOT_FOUND","PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","CURRENCY_NOT_SUPPORTED_BY_PROFILE","PROVIDER_NOT_SUPPORTED_BY_PROFILE","INSTRUMENT_NOT_FOUND","OWNER_IDENTITY_NOT_VERIFIED","IDENTITY_LIMITS_EXCEEDED","PROGRAMME_LIMITS_EXCEEDED","INNOVATOR_LIMITS_EXCEEDED","SYSTEM_LIMITS_EXCEEDED"]}}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"maxLength":50,"minLength":1,"type":"string","description":"Updates the friendly name of the managed account. Leave blank if no change is needed."},"lowBalanceThreshold":{"$ref":"#/components/schemas/AccountLowBalanceThreshold"},"clearLowBalanceThreshold":{"type":"boolean","description":"When true, clears the configured low balance threshold on the account. Ignored if lowBalanceThreshold is also provided."}}},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_ALREADY_UPGRADED_TO_IBAN","INSTRUMENT_IS_NOT_ACTIVE","IBAN_ALLOCATION_EXCEEDED","IBAN_NOT_SUPPORTED","IBAN_ALREADY_REQUESTED","OWNER_NOT_VERIFIED"]}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_INACTIVE","INSTRUMENT_ALREADY_BLOCKED","INSTRUMENT_DESTROYED"]}}},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_INACTIVE","INSTRUMENT_NOT_BLOCKED","INSTRUMENT_DESTROYED"]}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"maximum":500,"minimum":1,"type":"integer","format":"int32"},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InstrumentStatementSortOrder"},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/StatementResponseEntryTransactionType"}},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/AccessInstrumentType"}},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"string","enum":["LATEST"]},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionActivityType"}},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionActivityStatus"}},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionActivityDirection"},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionActivitySortBy"},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["BALANCE_NOT_ZERO","INSTRUMENT_ALREADY_REMOVED","INSTRUMENT_HAS_PENDING_ACTIONS","INSTRUMENT_HAS_LINKED_CARDS"]}}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/StatementTransactionType"}},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/StatementEntry"}},"id":"schema_485"},"schema_486":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_MODEL_CONSTRAINTS_VIOLATED","PROFILE_NOT_FOUND","PROFILE_INACTIVE","CURRENCY_NOT_SUPPORTED_BY_PROFILE","PROVIDER_NOT_SUPPORTED_BY_PROFILE","INSTRUMENT_NOT_FOUND","COUNTRY_INVALID","OWNER_IDENTITY_NOT_VERIFIED","IDENTITY_LIMITS_EXCEEDED","PROGRAMME_LIMITS_EXCEEDED","INNOVATOR_LIMITS_EXCEEDED","SYSTEM_LIMITS_EXCEEDED","PARENT_MANAGED_ACCOUNT_NOT_ACTIVE","PARENT_MANAGED_ACCOUNT_NOT_FOUND","WALLETS_NOT_ENABLED","WALLET_ARTWORK_NOT_SPECIFIED","WALLET_ARTWORK_INVALID","IDENTITY_KYC_LEVEL_STEPUP_REQUIRED","PUSHPROVISIONING_NOT_ENABLED","AUTH_FORWARDING_NOT_ENABLED","USER_NOT_ENROLLED_FOR_BIOMETRICS","BIOMETRIC_AUTHENTICATION_NOT_SUPPORTED","LINKED_USER_NOT_FOUND","USER_INACTIVE","INVALID_CHANNELS_SELECTED","INVALID_PRIMARY_CHANNEL_SELECTED","USER_MOBILE_NUMBER_DOES_NOT_EXIST","MORE_THAN_ONE_MOBILE_NUMBER_PROVIDED","MOBILE_NUMBER_ALREADY_EXISTS","TWILIO_AUTHY_AUTHENTICATION_NOT_SUPPORTED","USER_NOT_ENROLLED_FOR_TWILIO_AUTHY","RENEWAL_TYPE_NOT_SUPPORTED_BY_PROFILE","USER_CURRENCY_NOT_ENABLED","USER_CURRENCY_NOT_SUPPORTED_BY_PROFILE","USER_CURRENCY_SAME_AS_BASE_CURRENCY","PROFILE_TYPE_MISMATCH"]}}},"id":"schema_486"},"schema_487":{"kind":"json-schema","data":{"type":"string","enum":["VIRTUAL","PHYSICAL"]},"id":"schema_487"},"schema_488":{"kind":"json-schema","data":{"type":"string","enum":["RENEW","NO_RENEW"]},"id":"schema_488"},"schema_489":{"kind":"json-schema","data":{"pattern":"^[0-9]{6}$","type":"string"},"id":"schema_489"},"schema_490":{"kind":"json-schema","data":{"pattern":"^[0-9]{4}$","type":"string"},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"string","enum":["DEBIT_MODE","PREPAID_MODE"]},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/ManufacturingState"}},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"type":"object","properties":{"cards":{"type":"array","items":{"$ref":"#/components/schemas/ManagedCard"}},"count":{"type":"integer","description":"The total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"maxLength":50,"minLength":1,"type":"string","description":"Updates the friendly name of the card. Leave blank if no change is needed."},"nameOnCard":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"The card holder's name for the card.\n\nThis may be verified by merchants when the card is used online. For Physical cards, this field will be printed on the card.\nThe maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards.\n"},"nameOnCardLine2":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards."},"cardholderMobileNumber":{"maxLength":15,"minLength":5,"pattern":"^\\+[0-9]+$","type":"string","description":"The mobile number including country code of the card holder, needed in case a 3DS challenge is required.","deprecated":true},"billingAddress":{"description":"The billing address of the card holder. Merchants may request the billing address to be checked for online purchases.","$ref":"#/components/schemas/BillingAddress"},"deliveryAddress":{"description":"The delivery address set for the card holder. This is only applicable for physical cards.","$ref":"#/components/schemas/DeliveryAddress"},"deliveryMethod":{"$ref":"#/components/schemas/DeliveryMethod"},"digitalWallets":{"$ref":"#/components/schemas/DigitalWallets"},"authForwardingDefaultTimeoutDecision":{"type":"string","description":"Default decision for auth forwarding on timeout","enum":["APPROVE","DECLINE"]},"threeDSecureAuthConfig":{"$ref":"#/components/schemas/ThreeDSecureAuthConfig"},"externalData":{"$ref":"#/components/schemas/ExternalData"},"bulkDelivery":{"$ref":"#/components/schemas/BulkCardDelivery"},"activationCode":{"$ref":"#/components/schemas/PhysicalCardActivationCode","description":"The unique code to be used to activate the physical card."},"productReference":{"type":"string","description":"The product design reference to be used for this physical card.\n\nThis reference will be given to you once your physical card programme has been set up. If only one card programme is configured, this field can be left empty.\n"},"carrierType":{"type":"string","description":"The carrier type to be used for this physical card.\n\nThis reference will be given to you once your physical card carrier has been set up. If only one carrier is configured, this field can be left empty.\n"},"renewalType":{"$ref":"#/components/schemas/CardRenewalType"},"userId":{"$ref":"#/components/schemas/UserId","description":"The Authorised User to be linked to the card, whose authentication details will be used for actions such as 3DS authentication, or manual provisioning to a digital wallet. This field can be used instead of threeDSecureAuthConfig as it better describes the wider scope of possible uses."}}},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_DESTROYED","INSTRUMENT_NOT_PHYSICAL","COUNTRY_INVALID","WALLETS_NOT_ENABLED","WALLET_ARTWORK_NOT_SPECIFIED","WALLET_ARTWORK_INVALID","PUSHPROVISIONING_NOT_ENABLED","AUTH_FORWARDING_NOT_ENABLED","THREEDS_DETAILS_NOT_PROVIDED","USER_NOT_ENROLLED_FOR_BIOMETRICS","BIOMETRIC_AUTHENTICATION_NOT_SUPPORTED","LINKED_USER_NOT_FOUND","USER_INACTIVE","INVALID_CHANNELS_SELECTED","INVALID_PRIMARY_CHANNEL_SELECTED","USER_MOBILE_NUMBER_DOES_NOT_EXIST","MORE_THAN_ONE_MOBILE_NUMBER_PROVIDED","MOBILE_NUMBER_ALREADY_EXISTS","TWILIO_AUTHY_AUTHENTICATION_NOT_SUPPORTED","USER_NOT_ENROLLED_FOR_TWILIO_AUTHY","DELIVERY_METHOD_INVALID","CONTACT_NUMBER_NEEDED_FOR_BULK_DELIVERY","PRODUCT_REFERENCE_INVALID","CARRIER_TYPE_INVALID","CONFIG_ERROR_CARD_BUREAU","RENEWAL_TYPE_NOT_SUPPORTED_BY_PROFILE","CANNOT_REASSIGN_ACTIVE_CARD"]}}},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_ALREADY_BLOCKED","INSTRUMENT_DESTROYED","INSTRUMENT_MARKED_LOST_STOLEN"]}}},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_BLOCKED","INSTRUMENT_DESTROYED","INSTRUMENT_MARKED_LOST_STOLEN"]}}},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["BALANCE_NOT_ZERO","INSTRUMENT_ALREADY_REMOVED"]}}},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"required":["deliveryAddress"],"type":"object","properties":{"productReference":{"type":"string","description":"The product design reference to be used for this physical card.\n\nThis reference will be given to you once your physical card programme has been set up. If only one card programme is configured, this field can be left empty.\n"},"carrierType":{"type":"string","description":"The carrier type to be used for this physical card.\n\nThis reference will be given to you once your physical card carrier has been set up. If only one carrier is configured, this field can be left empty.\n"},"deliveryMethod":{"$ref":"#/components/schemas/DeliveryMethod"},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"activationCode":{"$ref":"#/components/schemas/PhysicalCardActivationCode","description":"A unique code that can be used when activating the physical card. This is an optional feature. An end-user will always need to be logged in to activate a card, but providing an activation code can give an additional layer of comfort to a user regarding security."},"pin":{"$ref":"#/components/schemas/SensitivePin"},"nameOnCardLine2":{"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards. This field is deprecated.","deprecated":true},"bulkDelivery":{"$ref":"#/components/schemas/BulkCardDelivery"}}},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_ALREADY_UPGRADED_TO_PHYSICAL","CONFIG_ERROR_PRODUCT_REFERENCE","PRODUCT_REFERENCE_NOT_SPECIFIED","PRODUCT_REFERENCE_INVALID","CONFIG_ERROR_CARRIER_TYPE","CARRIER_TYPE_NOT_SPECIFIED","CARRIER_TYPE_INVALID","CONFIG_ERROR_CARD_BUREAU","INSTRUMENT_BLOCKED","INSTRUMENT_DESTROYED","INSTRUMENT_NOT_ENABLED","PIN_INVALID_FORMAT","PARENT_MANAGED_ACCOUNT_BLOCKED","MAX_PRINT_CHARACTERS_EXCEEDED","DELIVERY_METHOD_INVALID","CONTACT_NUMBER_NEEDED_FOR_BULK_DELIVERY"]}}},"id":"schema_500"},"schema_501":{"kind":"json-schema","data":{"type":"object","properties":{"activationCode":{"$ref":"#/components/schemas/PhysicalCardActivationCode","description":"The code that was set up when upgrading the card, that can be used to activate a physical card. If provided in the request, this will be validated against the code that was originally provided. If left blank, no validation will be carried out."}}},"id":"schema_501"},"schema_502":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","INSTRUMENT_ALREADY_ACTIVATED","ACTIVATION_CODE_INVALID","INSTRUMENT_BLOCKED","INSTRUMENT_DESTROYED"]}}},"id":"schema_502"},"schema_503":{"kind":"json-schema","data":{"required":["pin"],"type":"object","properties":{"pin":{"$ref":"#/components/schemas/SensitivePin"}}},"id":"schema_503"},"schema_504":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","PHYSICAL_CARD_NOT_ACTIVATED","PIN_NOT_SET","PIN_TRIES_EXCEEDED","INSTRUMENT_BLOCKED","INSTRUMENT_DESTROYED"]}}},"id":"schema_504"},"schema_505":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","PHYSICAL_CARD_NOT_ACTIVATED","INSTRUMENT_BLOCKED","INSTRUMENT_DESTROYED"]}}},"id":"schema_505"},"schema_506":{"kind":"json-schema","data":{"required":["activationCode"],"type":"object","properties":{"activationCode":{"$ref":"#/components/schemas/PhysicalCardActivationCode","description":"The code that will be used to activate the physical card replacement."}}},"id":"schema_506"},"schema_507":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","PHYSICAL_CARD_NOT_ACTIVATED","INSTRUMENT_ALREADY_DESTROYED","INSTRUMENT_ALREADY_PENDING_REPLACEMENT","INSTRUMENT_MARKED_AS_LOST","MAX_PRINT_CHARACTERS_EXCEEDED"]}}},"id":"schema_507"},"schema_508":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","INSTRUMENT_ALREADY_MARKED_LOST","INSTRUMENT_ALREADY_MARKED_STOLEN","INSTRUMENT_DESTROYED"]}}},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","PHYSICAL_CARD_NOT_ACTIVATED","INSTRUMENT_ALREADY_MARKED_STOLEN","INSTRUMENT_ALREADY_MARKED_LOST","INSTRUMENT_DESTROYED"]}}},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"required":["activationCode"],"type":"object","properties":{"activationCode":{"$ref":"#/components/schemas/PhysicalCardActivationCode","description":"A unique code to be used to activate the replacement physical card."}}},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","INSTRUMENT_NOT_MARKED_LOST_OR_STOLEN","INSTRUMENT_DESTROYED","INSTRUMENT_ALREADY_REPLACED","PARENT_MANAGED_ACCOUNT_NOT_ACTIVE","MAX_PRINT_CHARACTERS_EXCEEDED"]}}},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSTRUMENT_NOT_PHYSICAL","PHYSICAL_CARD_NOT_ACTIVATED","INSTRUMENT_BLOCKED","INSTRUMENT_DESTROYED","PHYSICAL_CARD_TYPE_NOT_SUPPORTED"]}}},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"required":["profileId","source","destination","destinationAmount"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"source":{"description":"The managed account or managed card from where the funds will be transferred.","$ref":"#/components/schemas/InstrumentId"},"description":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":"The description details that are included in the transaction as reference."},"destination":{"description":"The managed account or managed card to where the funds will be transferred.","$ref":"#/components/schemas/InstrumentId"},"destinationAmount":{"description":"The amount, in same currency as the source and destination instruments, to be transferred to the destination (exclusive of any fee amount that may be specified in the profile).","$ref":"#/components/schemas/CurrencyAmount"},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"}}},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","INTERCEPTOR_DENIED_TRANSACTION","INSTRUMENT_DENIED_TRANSACTION","SOURCE_INSTRUMENT_DESTROYED","DESTINATION_INSTRUMENT_DESTROYED","FOREX_TRADE_DENIED_TRANSACTION","CURRENCY_MISMATCH","SOURCE_INSTRUMENT_BLOCKED","DESTINATION_INSTRUMENT_BLOCKED","FUNDS_INSUFFICIENT","AMOUNT_INVALID","SOURCE_NOT_FOUND","DESTINATION_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","DESTINATION_LIMIT_EXCEEDED","SOURCE_CANNOT_BE_DEBIT_MODE_CARD","DESTINATION_CANNOT_BE_DEBIT_MODE_CARD","TRANSFER_BETWEEN_INSTRUMENTS_UNSUPPORTED","SOURCE_AND_DESTINATION_MUST_BE_DIFFERENT","SCHEDULED_TIMESTAMP_INVALID"]}}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InstrumentId"},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/TransactionState"}},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"type":"object","properties":{"transfer":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"}},"count":{"type":"integer","description":"Total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"Total number of records returned in this response.","format":"int32"}}},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/IncomingWireTransferMultiState"}},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"type":"object","required":["id","source","destination","amount","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the bank transfer"},"source":{"type":"object","required":["instrument"],"properties":{"instrument":{"type":"object","required":["type","instrument"],"properties":{"type":{"type":"string","enum":["linked_accounts","unknown_sender_accounts"]},"instrument":{"oneOf":[{"$ref":"#/components/schemas/LinkedAccount"},{"$ref":"#/components/schemas/UnknownSenderAccount"}]},"reference":{"type":"string","description":"This is an external reference (if available), input by the sender when creating the payment, and intended for the recipient."}}}}},"destination":{"type":"object","required":["instrument","owner"],"properties":{"instrument":{"type":"object","required":["type","instrument"],"properties":{"type":{"type":"string","enum":["managed_accounts"]},"instrument":{"oneOf":[{"$ref":"#/components/schemas/ManagedAccount"}]}}},"owner":{"type":"object","required":["type","owner"],"properties":{"type":{"type":"string","enum":["consumers","corporates"]},"owner":{"oneOf":[{"$ref":"#/components/schemas/Corporate"},{"$ref":"#/components/schemas/Consumer"}]}}}}},"amount":{"$ref":"#/components/schemas/CurrencyAmount"},"timestamp":{"type":"integer","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision.","format":"int64"}}},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"string","enum":["APPROVED","DENIED"]}}},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","INTERCEPTOR_DENIED_TRANSACTION","INSTRUMENT_DENIED_TRANSACTION","CURRENCY_MISMATCH","SOURCE_INSTRUMENT_BLOCKED","SOURCE_INSTRUMENT_DESTROYED","AMOUNT_INVALID","FUNDS_INSUFFICIENT","SOURCE_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","TYPE_NOT_SUPPORTED_BY_PROFILE","IDENTITY_KYC_LEVEL_STEPUP_REQUIRED","BENEFICIARY_NOT_FOUND","BENEFICIARY_TYPE_INVALID","PROFILE_NOT_FOUND","SCHEDULED_TIMESTAMP_INVALID","BENEFICIARY_BANK_DETAILS_INVALID","PLUGIN_FILTER_DATA_INVALID","IBAN_UPGRADE_REQUIRED","EXTERNAL_DESTINATION_ACCOUNT_NOT_FOUND","PURPOSE_OF_PAYMENT_REQUIRED"]}}},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SourceInstrumentType"},"id":{"$ref":"#/components/schemas/Id"}}},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Id"},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SourceInstrumentType"},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/OutgoingWireTransferState"}},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"type":"object","properties":{"transfer":{"type":"array","items":{"$ref":"#/components/schemas/OutgoingWireTransfer"}},"count":{"type":"integer","description":"Total number of records (excluding the paging limit)","format":"int32"},"responseCount":{"type":"integer","description":"Total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVALID_STATE"]}}},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"STATE_INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction no longer requires additional verification, it was either cancelled or completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected cannot be used to verify this type of transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHANNEL_NOT_REGISTERED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The channel selected must be enrolled to receive one-time passwords before it can be used to verify this type of transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_EXEMPTION_APPLIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The transaction no longer requires additional verification, it was proceeded via PSD2 Regulation low value SCA exemption, it is either cancelled or completed."},"children":[]}]}]}]}],"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","SCA_EXEMPTION_APPLIED"]}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","SCA_EXEMPTION_APPLIED","CHALLENGE_LIMIT_EXCEEDED","ONE_CHALLENGE_LIMIT_REMAINING"]}}},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","CHALLENGE_LIMIT_EXCEEDED","SCA_EXEMPTION_APPLIED"]}}},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","CURRENCY_MISMATCH","SOURCE_INSTRUMENT_BLOCKED","SOURCE_INSTRUMENT_DESTROYED","AMOUNT_INVALID","FUNDS_INSUFFICIENT","SOURCE_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","TYPE_NOT_SUPPORTED_BY_PROFILE","PROFILE_NOT_FOUND","SCHEDULED_TIMESTAMP_INVALID","BENEFICIARY_BANK_DETAILS_INVALID","ORIGINATOR_DETAILS_INVALID","PROVIDER_REJECTED"]}}},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CorrespondentBankingOwtState"}},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"type":"string","enum":["INDIVIDUAL","BUSINESS"]},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"type":"object","properties":{"transfer":{"type":"array","items":{"$ref":"#/components/schemas/CorrespondentBankingOwt"}},"count":{"type":"integer","description":"Total number of records (excluding the paging limit)","format":"int32"},"responseCount":{"type":"integer","description":"Total number of records returned in this response (always capped at 100).","format":"int32"}}},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentStatus"}},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentType"}},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentSubtype"}},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CardPaymentEventType"}},"id":"schema_538"},"schema_539":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["SPEND_LIMIT_CURRENCY_DIFFERENT_FROM_CARD_CURRENCY","SPEND_LIMIT_NOT_SUPPORTED_FOR_PREPAID_MODE_CARD","SPEND_LIMIT_DUPLICATE_INTERVAL","SPEND_LIMIT_AMOUNT_INVALID","SPEND_RULE_ALREADY_SET","SPEND_LIMIT_CURRENCY_DIFFERENT_FROM_USER_CURRENCY"]}}},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["SPEND_LIMIT_CURRENCY_DIFFERENT_FROM_CARD_CURRENCY","SPEND_LIMIT_NOT_SUPPORTED_FOR_PREPAID_MODE_CARD","SPEND_LIMIT_DUPLICATE_INTERVAL","SPEND_LIMIT_AMOUNT_INVALID","SPEND_LIMIT_CURRENCY_DIFFERENT_FROM_USER_CURRENCY"]}}},"id":"schema_540"},"schema_541":{"kind":"json-schema","data":{"required":["errorCode"],"type":"object","properties":{"errorCode":{"type":"string","enum":["PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","INTERCEPTOR_DENIED_TRANSACTION","INSTRUMENT_DENIED_TRANSACTION","FOREX_TRADE_DENIED_TRANSACTION","CURRENCY_MISMATCH","SOURCE_INSTRUMENT_BLOCKED","DESTINATION_INSTRUMENT_BLOCKED","SOURCE_NOT_FOUND","DESTINATION_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","DESTINATION_LIMIT_EXCEEDED","FUNDS_INSUFFICIENT","AMOUNT_INVALID","SOURCE_CANNOT_BE_DEBIT_MODE_CARD","DESTINATION_CANNOT_BE_DEBIT_MODE_CARD","SEND_TO_INSTRUMENT_UNSUPPORTED","SOURCE_INSTRUMENT_DESTROYED","DESTINATION_INSTRUMENT_DESTROYED","SOURCE_AND_DESTINATION_MUST_BE_DIFFERENT","IDENTITY_KYC_LEVEL_STEPUP_REQUIRED","DESTINATION_BELONGS_TO_SAME_IDENTITY","SOURCE_AND_DESTINATION_MUST_BE_IN_SAME_PROGRAMME","BENEFICIARY_NOT_FOUND","BENEFICIARY_TYPE_INVALID","PROFILE_NOT_FOUND","SCHEDULED_TIMESTAMP_INVALID","DESTINATION_FEE_EXCEEDS_TRANSACTION_AMOUNT"]}}},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InstrumentType"},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/SendState"}},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"type":"object","properties":{"send":{"type":"array","items":{"$ref":"#/components/schemas/Send"}},"count":{"type":"integer","description":"Total number of records (excluding the paging limit).","format":"int32"},"responseCount":{"type":"integer","description":"Total number of records returned in this response.","format":"int32"}}},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","SCA_EXEMPTION_APPLIED"]}}},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID","CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","VERIFICATION_CODE_EXPIRED","VERIFICATION_CODE_INVALID","SCA_EXEMPTION_APPLIED","CHALLENGE_NOT_PENDING","CHALLENGE_LIMIT_EXCEEDED","ONE_CHALLENGE_LIMIT_REMAINING"]}}},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["UNRESOLVED_FEE_TYPE","UNRESOLVED_CURRENCY","UNRESOLVED_INSTRUMENT","FUNDS_INSUFFICIENT","IDENTITY_NOT_OWNER_OF_INSTRUMENT","FEE_AMOUNT_NOT_SET"]}}},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{}},"requestBody":{"required":["email","name","surname"],"type":"object","properties":{"name":{"minLength":1,"maxLength":50,"type":"string","description":"The first name of the user."},"surname":{"minLength":1,"maxLength":50,"type":"string","description":"The last name of the user."},"email":{"$ref":"#/components/schemas/Email"},"mobile":{"$ref":"#/components/schemas/Mobile"},"dateOfBirth":{"description":"Date of birth of the authorised user.","$ref":"#/components/schemas/Date"},"tag":{"$ref":"#/components/schemas/Tag"},"countryOfResidence":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"locale":{"$ref":"#/components/schemas/UserLocale"},"brand":{"$ref":"#/components/schemas/Brand"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/UserPredefinedRole"},"description":"Optional roles to assign to the user. For a full description of the permissions associated with each role, see our product documentation."}}}}},"maxItems":10000,"minItems":1},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"object","properties":{"bulkId":{"type":"string"},"operationCount":{"type":"integer"},"path":{"type":"string"}}},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{"_user_id_":{"$ref":"#/components/schemas/UserId"}}}}},"maxItems":10000,"minItems":1},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{"_id_":{"type":"string","pattern":"^[0-9]+$"}}}}},"maxItems":10000,"minItems":1},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{"_id_":{"type":"string","pattern":"^[0-9]+$"}}},"requestBody":{"$ref":"#/components/schemas/UpdateCardLevelSpendRules"}}},"maxItems":10000,"minItems":1},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{}},"requestBody":{"required":["profileId","source","destination","destinationAmount"],"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"source":{"description":"The managed account or managed card from where the funds will be transferred.","$ref":"#/components/schemas/InstrumentId"},"description":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":"The description details that are included in the transaction as reference."},"destination":{"description":"The managed account or managed card to where the funds will be transferred.","$ref":"#/components/schemas/InstrumentId"},"destinationAmount":{"description":"The amount, in same currency as the source and destination instruments, to be transferred to the destination (exclusive of any fee amount that may be specified in the profile).","$ref":"#/components/schemas/CurrencyAmount"},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"}}}}},"maxItems":10000,"minItems":1},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{}},"requestBody":{"$ref":"#/components/schemas/SendCreateRequest"}}},"maxItems":10000,"minItems":1},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"pathParams":{"type":"object","properties":{}},"requestBody":{"$ref":"#/components/schemas/OutgoingWireTransferCreateRequest"}}},"maxItems":10000,"minItems":1},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BulkProcessStatus"},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BulkId"},"id":"schema_557"},"schema_558":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BulkProcessOperationStatus"},"id":"schema_558"}},"exampleStore":{},"securitySchemeStore":{"api-key":{"id":"api-key","type":"apiKey","description":"An API key defined in your User API Client  (or Delegate API Client - this feature is available only to customers enabled with delegation functionality).  API Clients are as managed in the Embedder Portal","in":"header","paramName":"api-key"},"auth_token":{"id":"auth_token","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."},"webhooks_key":{"id":"webhooks_key","type":"apiKey","description":"The Webhooks key can be found in the API Credentials tab in your Portal Page.","in":"header","paramName":"webhooks-key"}},"servers":[{"url":"https://sandbox.weavr.io/multi","description":"Weavr Sandbox Environment"},{"url":"/_mock/products/multi/openapi","isMockServer":true,"description":"Mock server"}],"logo":{"imageUrl":"https://storage.googleapis.com/weavr-cdn/weavr_logo-new.png","href":"https://weavr.io","altText":"Weavr","backgroundColor":"#FFFFFF"}},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/products/multi/openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/multi/openapi.json?download"},{"url":"/_bundle/products/multi/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Weavr Multi Product API","description":"Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.\n\nBy integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.\n\n# Authentication\n\nEach request to the Multi API must include an `api-key` that represents your account. You can obtain an API Key by registering for a Multi account [here](https://portal.weavr.io).\n\nAlmost all endpoints require a secondary authentication token `auth_token` that represents the user for whom the request is being executed.\n"}},"baseSlug":"/products/multi/openapi","routesMapping":{}}