{"items":[{"type":"link","label":"Weavr Embedded Payment Run API","link":"/products/payment-run/openapi","routeSlug":"/products/payment-run/openapi","content":{"contentType":"overview","meta":{"name":"Weavr Embedded Payment Run API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/payment-run/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/payment-run/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"private","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":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Weavr Embedded Payment Run API (v1)","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 Payment Run Plug-in API provides a simple and flexible way for Embedders to add payment execution capabilities in their application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By integrating Weavr Payment Run plug-in API in your application, you can embed banking and payment capabilities within your app to boost productivity for your users in a seamless experience."},"children":[]}]}]}]}],"sectionId":"/products/payment-run/openapi"}],"sectionId":"/products/payment-run/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 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 Embedder account "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://portal.weavr.io/register/?plugin=payment-run"},"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/payment-run/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/postman-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To help you get started with your integration, you can download the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://postman.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://sandbox.weavr.io/payment-run/v1/postman"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The collection includes the steps you’ll need to follow to integrate Embedded Payment Run within your app."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The collection makes use of environment variables to pre-fill details associated with your Sandbox account, such as your account’s API Key. You can download your Sandbox Account environment file from the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://portal.weavr.io/register/?plugin=payment-run"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/products/payment-run/openapi/section/postman-collection"}]}]}},{"type":"link","label":"Authentication","link":"/products/payment-run/openapi/section/authentication","routeSlug":"/products/payment-run/openapi/section/authentication","content":null},{"type":"link","label":"Postman Collection","link":"/products/payment-run/openapi/section/postman-collection","routeSlug":"/products/payment-run/openapi/section/postman-collection","content":null},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Tokens","link":"/products/payment-run/openapi/tokens","routeSlug":"/products/payment-run/openapi/tokens","items":[{"label":"Acquire auth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/tokens/acquireauthtoken","routeSlug":"/products/payment-run/openapi/tokens/acquireauthtoken","metadata":{"seo":{"title":"Acquire auth token","description":"Authenticate a user with the email and password that they provided when registering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acquireAuthToken","name":"Acquire auth token","isWebhook":false,"pointer":"/paths/~1v1~1login_with_password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acquire auth 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":"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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_608"}},"schemaId":"schema_608","pointer":"/paths/~1v1~1login_with_password/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/login_with_password","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_608"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/v1/login_with_password","href":"tokens/acquireauthtoken","openApiOperationId":"acquireAuthToken","summary":"Acquire auth token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_608","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_608"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}},"schemaId":"schema_609","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"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_613"}},"schemaId":"schema_613"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1login_with_password/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_609","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_613","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/acquireauthtoken"}],"panels":[]}]},"httpPath":"/v1/login_with_password"},{"label":"Logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/tokens/logout","routeSlug":"/products/payment-run/openapi/tokens/logout","metadata":{"seo":{"title":"Logout","description":"Logs out the user and terminates the session identified by theauth_token in the Authorization Header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logout","name":"Logout","isWebhook":false,"pointer":"/paths/~1v1~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout","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":"Logs out the user and terminates the session identified by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/logout","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","429","500","503","default"],"pointer":"/v1/logout","href":"tokens/logout","openApiOperationId":"logout","summary":"Logout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1logout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens/logout"}],"panels":[]}]},"httpPath":"/v1/logout"}],"content":{"contentType":"group","meta":{"name":"Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tokens","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/login_with_password","summary":"Acquire auth token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/acquireauthtoken","deprecated":false},{"title":"/v1/logout","summary":"Logout","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens/logout","deprecated":false}]}]}]}]}},{"type":"group","label":"Passwords","link":"/products/payment-run/openapi/passwords","routeSlug":"/products/payment-run/openapi/passwords","items":[{"label":"Create a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordcreate","routeSlug":"/products/payment-run/openapi/passwords/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/~1v1~1password~1{user_id}/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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1password~1{user_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616","pointer":"/paths/~1v1~1password~1{user_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/password/{user_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_616"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/password/{user_id}","href":"passwords/passwordcreate","openApiOperationId":"passwordCreate","summary":"Create a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_616"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}},"schemaId":"schema_617","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_618"}},"schemaId":"schema_618"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1password~1{user_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_617","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_618","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_618"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/passwords/passwordcreate"}],"panels":[]}]},"httpPath":"/v1/password/{user_id}"},{"label":"Update a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordupdate","routeSlug":"/products/payment-run/openapi/passwords/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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_619"}},"schemaId":"schema_619","pointer":"/paths/~1v1~1passwords~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/passwords/update","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_619"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/v1/passwords/update","href":"passwords/passwordupdate","openApiOperationId":"passwordUpdate","summary":"Update a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_619","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_619"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}},"schemaId":"schema_617","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}},"schemaId":"schema_620"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1passwords~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_617","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_620","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/passwords/passwordupdate"}],"panels":[]}]},"httpPath":"/v1/passwords/update"},{"label":"Validate a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordvalidate","routeSlug":"/products/payment-run/openapi/passwords/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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616","pointer":"/paths/~1v1~1passwords~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/passwords/validate","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_616"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/v1/passwords/validate","href":"passwords/passwordvalidate","openApiOperationId":"passwordValidate","summary":"Validate a password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_616"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}},"schemaId":"schema_620"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1passwords~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_620","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/passwords/passwordvalidate"}],"panels":[]}]},"httpPath":"/v1/passwords/validate"},{"label":"Initiate lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/lostpasswordinitiate","routeSlug":"/products/payment-run/openapi/passwords/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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"schemaId":"schema_621","pointer":"/paths/~1v1~1passwords~1lost_password~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/passwords/lost_password/start","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_621"}},"responseCodes":["204","400","401","403","409","429","500","503","default"],"pointer":"/v1/passwords/lost_password/start","href":"passwords/lostpasswordinitiate","openApiOperationId":"lostPasswordInitiate","summary":"Initiate lost password process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_621","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_622"}},"schemaId":"schema_622"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1passwords~1lost_password~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_622","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_622"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/passwords/lostpasswordinitiate"}],"panels":[]}]},"httpPath":"/v1/passwords/lost_password/start"},{"label":"Resume lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/lostpasswordresume","routeSlug":"/products/payment-run/openapi/passwords/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/~1v1~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.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_623"}},"schemaId":"schema_623","pointer":"/paths/~1v1~1passwords~1lost_password~1resume/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/passwords/lost_password/resume","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_623"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/v1/passwords/lost_password/resume","href":"passwords/lostpasswordresume","openApiOperationId":"lostPasswordResume","summary":"Resume lost password process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_623","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_623"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}},"schemaId":"schema_624","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}},"schemaId":"schema_625"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1passwords~1lost_password~1resume/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_624","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_625","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/passwords/lostpasswordresume"}],"panels":[]}]},"httpPath":"/v1/passwords/lost_password/resume"}],"content":{"contentType":"group","meta":{"name":"Passwords"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Passwords","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/password/{user_id}","summary":"Create a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/passwords/passwordcreate","deprecated":false},{"title":"/v1/passwords/update","summary":"Update a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/passwords/passwordupdate","deprecated":false},{"title":"/v1/passwords/validate","summary":"Validate a password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/passwords/passwordvalidate","deprecated":false},{"title":"/v1/passwords/lost_password/start","summary":"Initiate lost password process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/passwords/lostpasswordinitiate","deprecated":false},{"title":"/v1/passwords/lost_password/resume","summary":"Resume lost password process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/passwords/lostpasswordresume","deprecated":false}]}]}]}]}},{"type":"separator","label":"Authorisation","content":null},{"type":"group","label":"Additional Factors","link":"/products/payment-run/openapi/additional-factors","routeSlug":"/products/payment-run/openapi/additional-factors","items":[{"label":"Enrol a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/additional-factors/enroldeviceusingotpstepone","routeSlug":"/products/payment-run/openapi/additional-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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1v1~1authentication_factors~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/authentication_factors/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/authentication_factors/otp/{channel}","href":"additional-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/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1authentication_factors~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_626"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/additional-factors/enroldeviceusingotpstepone"}],"panels":[]}]},"httpPath":"/v1/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/payment-run/openapi/additional-factors/enroldeviceusingotpsteptwo","routeSlug":"/products/payment-run/openapi/additional-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."}},"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/~1v1~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":"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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1v1~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_627"}},"schemaId":"schema_627","pointer":"/paths/~1v1~1authentication_factors~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/authentication_factors/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_627"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/authentication_factors/otp/{channel}/verify","href":"additional-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/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_627","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_627"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_628"}},"schemaId":"schema_628"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1authentication_factors~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_628","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_628"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/additional-factors/enroldeviceusingotpsteptwo"}],"panels":[]}]},"httpPath":"/v1/authentication_factors/otp/{channel}/verify"}],"content":{"contentType":"group","meta":{"name":"Additional Factors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Additional Factors","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/authentication_factors/otp/{channel}","summary":"Enrol a user device for authentication using one-time passwords","prefix":{"name":"post","color":"post"},"badges":[],"link":"/additional-factors/enroldeviceusingotpstepone","deprecated":false},{"title":"/v1/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":"/additional-factors/enroldeviceusingotpsteptwo","deprecated":false}]}]}]}]}},{"type":"group","label":"Step up","link":"/products/payment-run/openapi/step-up","routeSlug":"/products/payment-run/openapi/step-up","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/payment-run/openapi/step-up/stepupscachallenge","routeSlug":"/products/payment-run/openapi/step-up/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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1v1~1stepup~1challenges~1otp~1{channel}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1stepup~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/stepup/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/stepup/challenges/otp/{channel}","href":"step-up/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/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_630"}},"schemaId":"schema_630"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1stepup~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_630","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_630"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-up/stepupscachallenge"}],"panels":[]}]},"httpPath":"/v1/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/payment-run/openapi/step-up/stepupscaverify","routeSlug":"/products/payment-run/openapi/step-up/stepupscaverify","metadata":{"seo":{"title":"Verify a step-up token using a one-time password","description":"Completes the verification process for a step up token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stepupSCAVerify","name":"Verify a step-up token using a one-time password","isWebhook":false,"pointer":"/paths/~1v1~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":"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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true}],"pointer":"/paths/~1v1~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_629","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/~1v1~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_627"}},"schemaId":"schema_627","pointer":"/paths/~1v1~1stepup~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/stepup/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_627"}},"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/stepup/challenges/otp/{channel}/verify","href":"step-up/stepupscaverify","openApiOperationId":"stepupSCAVerify","summary":"Verify a step-up token using a one-time password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_627","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_627"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631"}},"schemaId":"schema_631"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1stepup~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_631","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/step-up/stepupscaverify"}],"panels":[]}]},"httpPath":"/v1/stepup/challenges/otp/{channel}/verify"}],"content":{"contentType":"group","meta":{"name":"Step up"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Step up","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/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/stepupscachallenge","deprecated":false},{"title":"/v1/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/stepupscaverify","deprecated":false}]}]}]}]}},{"type":"separator","label":"Identities","content":null},{"type":"group","label":"Buyers","link":"/products/payment-run/openapi/buyers","routeSlug":"/products/payment-run/openapi/buyers","items":[{"label":"Create a buyer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyercreate","routeSlug":"/products/payment-run/openapi/buyers/buyercreate","metadata":{"seo":{"title":"Create a buyer","description":"Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerCreate","name":"Create a buyer","isWebhook":false,"pointer":"/paths/~1v1~1buyers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a buyer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin. \n\nThe information provided must be accurate and will be passed on for KYB verification with our partner.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1buyers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632"}},"schemaId":"schema_632","pointer":"/paths/~1v1~1buyers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/buyers","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_632"}},"responseCodes":["200","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/buyers","href":"buyers/buyercreate","openApiOperationId":"buyerCreate","summary":"Create a buyer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_632","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632"}},"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_633"}},"schemaId":"schema_633","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_634"}},"schemaId":"schema_634"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_633","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_634","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_634"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyercreate"}],"panels":[]}]},"httpPath":"/v1/buyers"},{"label":"Get buyer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerget","routeSlug":"/products/payment-run/openapi/buyers/buyerget","metadata":{"seo":{"title":"Get buyer details","description":"Retrieve the details of the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerGet","name":"Get buyer details","isWebhook":false,"pointer":"/paths/~1v1~1buyers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get buyer details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the details of the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/buyers","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/buyers","href":"buyers/buyerget","openApiOperationId":"buyerGet","summary":"Get buyer details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_635"}},"schemaId":"schema_635","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_635","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_635"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyerget"}],"panels":[]}]},"httpPath":"/v1/buyers"},{"label":"Update a buyer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerupdate","routeSlug":"/products/payment-run/openapi/buyers/buyerupdate","metadata":{"seo":{"title":"Update a buyer","description":"Update the buyer currencies and admin roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerUpdate","name":"Update a buyer","isWebhook":false,"pointer":"/paths/~1v1~1buyers/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a buyer","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 buyer currencies and admin roles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_636"}},"schemaId":"schema_636","pointer":"/paths/~1v1~1buyers/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/buyers","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_636"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/v1/buyers","href":"buyers/buyerupdate","openApiOperationId":"buyerUpdate","summary":"Update a buyer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_636","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_636"}},"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_637"}},"schemaId":"schema_637"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638"}},"schemaId":"schema_638","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_639"}},"schemaId":"schema_639"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_637","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_637"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638"}}},{"code":"409","schemaId":"schema_639","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_639"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyerupdate"}],"panels":[]}]},"httpPath":"/v1/buyers"},{"label":"Start admin user email verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyeradminuseremailverificationcodesend","routeSlug":"/products/payment-run/openapi/buyers/buyeradminuseremailverificationcodesend","metadata":{"seo":{"title":"Start admin user email verification","description":"The first step in verifying a admin user's email. The admin user whose email address is to be verified is sent an email containing a randomly generated code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerAdminUserEmailVerificationCodeSend","name":"Start admin user email verification","isWebhook":false,"pointer":"/paths/~1v1~1buyers~1verification~1email~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start admin user email verification","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 admin user's email. The admin 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":"buyerAdminUserEmailVerify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to verify the admin 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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1buyers~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_621"}},"schemaId":"schema_621","pointer":"/paths/~1v1~1buyers~1verification~1email~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/buyers/verification/email/send","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_621"}},"responseCodes":["204","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/buyers/verification/email/send","href":"buyers/buyeradminuseremailverificationcodesend","openApiOperationId":"buyerAdminUserEmailVerificationCodeSend","summary":"Start admin user email verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_621","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_640"}},"schemaId":"schema_640"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers~1verification~1email~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_640","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_640"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyeradminuseremailverificationcodesend"}],"panels":[]}]},"httpPath":"/v1/buyers/verification/email/send"},{"label":"Verify admin user email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyeradminuseremailverify","routeSlug":"/products/payment-run/openapi/buyers/buyeradminuseremailverify","metadata":{"seo":{"title":"Verify admin user email","description":"The second step in verifying the admin user's email. The randomly generated code sent to the admin user viaemail, using the buyerAdminUserEmailVerificationCodeSend operation, is submitted here to verify the admin user's email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerAdminUserEmailVerify","name":"Verify admin user email","isWebhook":false,"pointer":"/paths/~1v1~1buyers~1verification~1email~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify admin user email","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 admin user's email. The randomly generated code sent to the admin 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":"buyerAdminUserEmailVerificationCodeSend"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation, is submitted here to verify the admin 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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1buyers~1verification~1email~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_641"}},"schemaId":"schema_641","pointer":"/paths/~1v1~1buyers~1verification~1email~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/buyers/verification/email/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_641"}},"responseCodes":["204","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/buyers/verification/email/verify","href":"buyers/buyeradminuseremailverify","openApiOperationId":"buyerAdminUserEmailVerify","summary":"Verify admin user email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_641","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_641"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_642"}},"schemaId":"schema_642"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers~1verification~1email~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_642","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_642"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyeradminuseremailverify"}],"panels":[]}]},"httpPath":"/v1/buyers/verification/email/verify"},{"label":"Start buyer KYB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerkybstart","routeSlug":"/products/payment-run/openapi/buyers/buyerkybstart","metadata":{"seo":{"title":"Start buyer KYB","description":"Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerKybStart","name":"Start buyer KYB","isWebhook":false,"pointer":"/paths/~1v1~1buyers~1kyb/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start buyer KYB","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":"Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers."},"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 buyer that the logged-in user belongs to."},"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 buyer 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":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1buyers~1kyb/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/buyers/kyb","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/buyers/kyb","href":"buyers/buyerkybstart","openApiOperationId":"buyerKybStart","summary":"Start buyer KYB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_643"}},"schemaId":"schema_643","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_644"}},"schemaId":"schema_644"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers~1kyb/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_643","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_643"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_644","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_644"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyerkybstart"}],"panels":[]}]},"httpPath":"/v1/buyers/kyb"},{"label":"Get buyer KYB status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerkybget","routeSlug":"/products/payment-run/openapi/buyers/buyerkybget","metadata":{"seo":{"title":"Get buyer KYB status","description":"Returns the KYB status for the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerKybGet","name":"Get buyer KYB status","isWebhook":false,"pointer":"/paths/~1v1~1buyers~1kyb/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get buyer KYB status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the KYB status for the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/buyers/kyb","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/buyers/kyb","href":"buyers/buyerkybget","openApiOperationId":"buyerKybGet","summary":"Get buyer KYB status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_645"}},"schemaId":"schema_645","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers~1kyb/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_645","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_645"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyerkybget"}],"panels":[]}]},"httpPath":"/v1/buyers/kyb"},{"label":"Update Buyer's KYB details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerupdatekyb","routeSlug":"/products/payment-run/openapi/buyers/buyerupdatekyb","metadata":{"seo":{"title":"Update Buyer's KYB details","description":"Update the details of the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buyerUpdateKyb","name":"Update Buyer's KYB details","isWebhook":false,"pointer":"/paths/~1v1~1buyers~1kyb/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Buyer's KYB details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the details of the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following Buyer details are verified during due diligence (KYB) and cannot be updated via the API once the Buyer 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":"Admin User Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin User Surname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin User Email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin 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":"Admin User Mobile Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin Date of Birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company Business 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":"If these details need to be changed after due diligence is completed, please contact Customer Support to restart the Due Diligence process."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_646"}},"schemaId":"schema_646","pointer":"/paths/~1v1~1buyers~1kyb/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/buyers/kyb","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_646"}},"responseCodes":["200","400","401","403","409","429","500","503","default"],"pointer":"/v1/buyers/kyb","href":"buyers/buyerupdatekyb","openApiOperationId":"buyerUpdateKyb","summary":"Update Buyer's KYB details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_646","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_646"}},"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_637"}},"schemaId":"schema_637"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_634"}},"schemaId":"schema_634"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1buyers~1kyb/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_637","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_637"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_634","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_634"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers/buyerupdatekyb"}],"panels":[]}]},"httpPath":"/v1/buyers/kyb"}],"content":{"contentType":"group","meta":{"name":"Buyers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyers","showPageActions":true},{"nodeType":"markdoc","content":"Buyers are identities representing a business\n\nOnce on-boarded, Buyers can create payment runs and pay their suppliers in your application."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/buyers","summary":"Create a buyer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers/buyercreate","deprecated":false},{"title":"/v1/buyers","summary":"Get buyer details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/buyers/buyerget","deprecated":false},{"title":"/v1/buyers","summary":"Update a buyer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/buyers/buyerupdate","deprecated":false},{"title":"/v1/buyers/verification/email/send","summary":"Start admin user email verification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers/buyeradminuseremailverificationcodesend","deprecated":false},{"title":"/v1/buyers/verification/email/verify","summary":"Verify admin user email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers/buyeradminuseremailverify","deprecated":false},{"title":"/v1/buyers/kyb","summary":"Start buyer KYB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers/buyerkybstart","deprecated":false},{"title":"/v1/buyers/kyb","summary":"Get buyer KYB status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/buyers/buyerkybget","deprecated":false},{"title":"/v1/buyers/kyb","summary":"Update Buyer's KYB details","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/buyers/buyerupdatekyb","deprecated":false}]}]}]}]}},{"type":"group","label":"Buyer Authorised Users","link":"/products/payment-run/openapi/buyer-authorised-users","routeSlug":"/products/payment-run/openapi/buyer-authorised-users","items":[{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usercreate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/usercreate","metadata":{"seo":{"title":"Create a user","description":"Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here Step-Up."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userCreate","name":"Create a user","isWebhook":false,"pointer":"/paths/~1v1~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create 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 that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/stepup/challenges/otp/{channel}"},"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":"https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-Up"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once on-boarded, users have access and manage the buyer's payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users are assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which limit the level of access they have and what they can do on behalf of the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1users/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_647"}},"schemaId":"schema_647","pointer":"/paths/~1v1~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_647"}},"responseCodes":["200","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/users","href":"buyer-authorised-users/usercreate","openApiOperationId":"userCreate","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_647","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_647"}},"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_648"}},"schemaId":"schema_648"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638"}},"schemaId":"schema_638","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_649"}},"schemaId":"schema_649"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_648"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_638","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638"}}},{"code":"409","schemaId":"schema_649","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_649"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/usercreate"}],"panels":[]}]},"httpPath":"/v1/users"},{"label":"Get all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usersget","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/usersget","metadata":{"seo":{"title":"Get all users","description":"Fetches all authorised users associated with the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"usersGet","name":"Get all users","isWebhook":false,"pointer":"/paths/~1v1~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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches all authorised users associated with the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_650","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_651","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"active","in":"query","schemaId":"schema_652"},{"name":"email","in":"query","schemaId":"schema_653"}],"pointer":"/paths/~1v1~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/users","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_650"},{"name":"limit","in":"query","required":false,"schemaId":"schema_651"},{"name":"active","in":"query","required":false,"schemaId":"schema_652"},{"name":"email","in":"query","required":false,"schemaId":"schema_653"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/users","href":"buyer-authorised-users/usersget","openApiOperationId":"usersGet","summary":"Get all users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_654"}},"schemaId":"schema_654","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_654","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_654"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/usersget"}],"panels":[]}]},"httpPath":"/v1/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usergetbyid","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/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/~1v1~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":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/users/{user_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/v1/users/{user_id}","href":"buyer-authorised-users/usergetbyid","openApiOperationId":"userGetById","summary":"Get a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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_648"}},"schemaId":"schema_648","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_648"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/usergetbyid"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userupdate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userupdate","metadata":{"seo":{"title":"Update a user","description":"Update the details of a user identified by the user_id in the the path parameter. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here Step-Up.."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userUpdate","name":"Update a user","isWebhook":false,"pointer":"/paths/~1v1~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 user_id in the the path parameter. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.weavr.io/payment-run/plugin-api/plugin-api-authentication-stepup/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-Up"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the 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 Additional Factors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~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_655"}},"schemaId":"schema_655","pointer":"/paths/~1v1~1users~1{user_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/users/{user_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_655"}},"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/users/{user_id}","href":"buyer-authorised-users/userupdate","openApiOperationId":"userUpdate","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_655","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_655"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_648"}},"schemaId":"schema_648"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656"}},"schemaId":"schema_656"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_648","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_648"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_656","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/userupdate"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}"},{"label":"Activate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/useractivate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/useractivate","metadata":{"seo":{"title":"Activate a user","description":"Activate the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userActivate","name":"Activate a user","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate 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":"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":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1activate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1users~1{user_id}~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/activate","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/users/{user_id}/activate","href":"buyer-authorised-users/useractivate","openApiOperationId":"userActivate","summary":"Activate a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_657"}},"schemaId":"schema_657"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_657","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_657"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/useractivate"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/activate"},{"label":"Deactivate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userdeactivate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userdeactivate","metadata":{"seo":{"title":"Deactivate a user","description":"De-activate the user identified by the user_id path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userDeactivate","name":"Deactivate a user","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate 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":"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":"This operations is not final and a user can be re-activated using the userActivate operation. Note that another active user would need to log in so as to re-activate the de-activated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1deactivate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1users~1{user_id}~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/deactivate","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/users/{user_id}/deactivate","href":"buyer-authorised-users/userdeactivate","openApiOperationId":"userDeactivate","summary":"Deactivate a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_657"}},"schemaId":"schema_657"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_657","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_657"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/userdeactivate"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/deactivate"},{"label":"Send a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinvitesend","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinvitesend","metadata":{"seo":{"title":"Send a user invite","description":"Once a user is created using the userCreate operation, the user needs to setup his/her password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userInviteSend","name":"Send a user invite","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1invite/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a user 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":"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, the user needs to setup his/her password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1invite/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1users~1{user_id}~1invite/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/invite","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/users/{user_id}/invite","href":"buyer-authorised-users/userinvitesend","openApiOperationId":"userInviteSend","summary":"Send a user invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/userinvitesend"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/invite"},{"label":"Validate a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinvitevalidate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinvitevalidate","metadata":{"seo":{"title":"Validate a user 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 invite","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1invite~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a user 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\nto avoid having the user fill in a form only to be held by a validation issue\n(eg. expired invite).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1invite~1validate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~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_659"}},"schemaId":"schema_659","pointer":"/paths/~1v1~1users~1{user_id}~1invite~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/invite/validate","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_659"}},"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/users/{user_id}/invite/validate","href":"buyer-authorised-users/userinvitevalidate","openApiOperationId":"userInviteValidate","summary":"Validate a user invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_659"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}},"schemaId":"schema_660"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}~1invite~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_660","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/userinvitevalidate"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/invite/validate"},{"label":"Consume a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinviteconsume","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinviteconsume","metadata":{"seo":{"title":"Consume a user invite","description":"Consumes an invitation previously 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 invite","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1invite~1consume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consume a user 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 previously 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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"components/schemas/UserId","description":"The unique identifier for the user.","required":true}],"pointer":"/paths/~1v1~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_629","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/~1v1~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_661"}},"schemaId":"schema_661","pointer":"/paths/~1v1~1users~1{user_id}~1invite~1consume/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/invite/consume","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"110747174434373672","schemaId":"components/schemas/UserId"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_661"}},"responseCodes":["200","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/users/{user_id}/invite/consume","href":"buyer-authorised-users/userinviteconsume","openApiOperationId":"userInviteConsume","summary":"Consume a user invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_661","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_661"}},"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_624"}},"schemaId":"schema_624","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}},"schemaId":"schema_662"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1{user_id}~1invite~1consume/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_624","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_624"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_662","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/userinviteconsume"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/invite/consume"},{"label":"Send an email verification code to the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverificationcodesend","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverificationcodesend","metadata":{"seo":{"title":"Send an email verification code to the authorised 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 the authorised user","isWebhook":false,"pointer":"/paths/~1v1~1users~1verification~1email~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an email verification code to 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 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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~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_621"}},"schemaId":"schema_621","pointer":"/paths/~1v1~1users~1verification~1email~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/verification/email/send","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_621"}},"responseCodes":["204","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/users/verification/email/send","href":"buyer-authorised-users/authoriseduseremailverificationcodesend","openApiOperationId":"authorisedUserEmailVerificationCodeSend","summary":"Send an email verification code to the authorised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_621","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_663"}},"schemaId":"schema_663"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1verification~1email~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_663","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_663"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/authoriseduseremailverificationcodesend"}],"panels":[]}]},"httpPath":"/v1/users/verification/email/send"},{"label":"Verify email of the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverify","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/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/~1v1~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":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1users~1verification~1email~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_641"}},"schemaId":"schema_641","pointer":"/paths/~1v1~1users~1verification~1email~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/verification/email/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_641"}},"responseCodes":["204","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/users/verification/email/verify","href":"buyer-authorised-users/authoriseduseremailverify","openApiOperationId":"authorisedUserEmailVerify","summary":"Verify email of the authorised user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_641","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_641"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_642"}},"schemaId":"schema_642"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1users~1verification~1email~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_642","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_642"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyer-authorised-users/authoriseduseremailverify"}],"panels":[]}]},"httpPath":"/v1/users/verification/email/verify"}],"content":{"contentType":"group","meta":{"name":"Buyer Authorised Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyer Authorised Users","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyers can invite authorised users to access their account. Once on-boarded, authorised users can transact on behalf of the identity they are on-boarded with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorised users are typically employees who have access to company's banking accounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints are to be used only for performing operations related to authorised users - getting or updating the details of "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" users is to be done via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/buyers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/usercreate","deprecated":false},{"title":"/v1/users","summary":"Get all users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/buyer-authorised-users/usersget","deprecated":false},{"title":"/v1/users/{user_id}","summary":"Get a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/buyer-authorised-users/usergetbyid","deprecated":false},{"title":"/v1/users/{user_id}","summary":"Update a user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/buyer-authorised-users/userupdate","deprecated":false},{"title":"/v1/users/{user_id}/activate","summary":"Activate a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/useractivate","deprecated":false},{"title":"/v1/users/{user_id}/deactivate","summary":"Deactivate a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/userdeactivate","deprecated":false},{"title":"/v1/users/{user_id}/invite","summary":"Send a user invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/userinvitesend","deprecated":false},{"title":"/v1/users/{user_id}/invite/validate","summary":"Validate a user invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/userinvitevalidate","deprecated":false},{"title":"/v1/users/{user_id}/invite/consume","summary":"Consume a user invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/userinviteconsume","deprecated":false},{"title":"/v1/users/verification/email/send","summary":"Send an email verification code to the authorised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/authoriseduseremailverificationcodesend","deprecated":false},{"title":"/v1/users/verification/email/verify","summary":"Verify email of the authorised user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyer-authorised-users/authoriseduseremailverify","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payment runs","content":null},{"type":"group","label":"Payment runs","link":"/products/payment-run/openapi/payment-runs","routeSlug":"/products/payment-run/openapi/payment-runs","items":[{"label":"Create a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrun","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrun","metadata":{"seo":{"title":"Create a payment run","description":"Create a new payment run containing a list of outstanding supplier payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPaymentRun","name":"Create a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a payment run","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 payment run containing a list of outstanding supplier payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that all the supplier payments in a payment run is limited to one currency. The currency of the payment run are enabled upon the Buyer’s registration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_664"}},"schemaId":"schema_664","pointer":"/paths/~1v1~1payment_runs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment_runs","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_664"}},"responseCodes":["200","400","401","403","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs","href":"payment-runs/postpaymentrun","openApiOperationId":"postPaymentRun","summary":"Create a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_664","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_664"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_665"}},"schemaId":"schema_665"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}},"schemaId":"schema_666"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_665","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_665"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_666","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/postpaymentrun"}],"panels":[]}]},"httpPath":"/v1/payment_runs"},{"label":"Get payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentruns","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentruns","metadata":{"seo":{"title":"Get payment runs","description":"Retrieve the list of payment runs belonging to the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentRuns","name":"Get payment runs","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment runs","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 list of payment runs belonging to the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user roles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_651","description":"The limit of the results for paging, starting at the offset. Limit is always capped at 100."},{"name":"offset","in":"query","schemaId":"schema_650","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":"tag","in":"query","schemaId":"schema_667","description":"Filter by tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries."},{"name":"status","in":"query","schemaId":"schema_668"},{"name":"reference","in":"query","schemaId":"schema_669"},{"name":"min_amount","in":"query","schemaId":"schema_670"},{"name":"max_amount","in":"query","schemaId":"schema_671"}],"pointer":"/paths/~1v1~1payment_runs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment_runs","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_651"},{"name":"offset","in":"query","required":false,"schemaId":"schema_650"},{"name":"tag","in":"query","required":false,"schemaId":"schema_667"},{"name":"status","in":"query","required":false,"example":"PENDING_CONFIRMATION","schemaId":"schema_668"},{"name":"reference","in":"query","required":false,"schemaId":"schema_669"},{"name":"min_amount","in":"query","required":false,"schemaId":"schema_670"},{"name":"max_amount","in":"query","required":false,"schemaId":"schema_671"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/payment_runs","href":"payment-runs/getpaymentruns","openApiOperationId":"getPaymentRuns","summary":"Get payment runs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_672"}},"schemaId":"schema_672"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_672","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_672"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/getpaymentruns"}],"panels":[]}]},"httpPath":"/v1/payment_runs"},{"label":"Get a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentrunsid","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentrunsid","metadata":{"seo":{"title":"Get a payment run","description":"Retrieve a payment run belonging to the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentRunsId","name":"Get a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a payment run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a payment run belonging to the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user roles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment_runs/{payment_run_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}","href":"payment-runs/getpaymentrunsid","openApiOperationId":"getPaymentRunsId","summary":"Get a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_674"}},"schemaId":"schema_674"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_674","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_674"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/getpaymentrunsid"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}"},{"label":"Update a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/putpaymentrunsid","routeSlug":"/products/payment-run/openapi/payment-runs/putpaymentrunsid","metadata":{"seo":{"title":"Update a payment","description":"Update the details of a payment identified by the paymentId that is in the PENDING_CONFIRMATION state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putPaymentRunsId","name":"Update a payment","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the details of a payment identified by the paymentId that is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_675"}},"schemaId":"schema_675","pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment_runs/{payment_run_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_675"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}","href":"payment-runs/putpaymentrunsid","openApiOperationId":"putPaymentRunsId","summary":"Update a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_675","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_675"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_676"}},"schemaId":"schema_676"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_676","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_676"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/putpaymentrunsid"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}"},{"label":"Confirm a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrunsidconfirm","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrunsidconfirm","metadata":{"seo":{"title":"Confirm a payment run","description":"Confirm that a payment run can be executed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPaymentRunsIdConfirm","name":"Confirm a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1confirm/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm a payment run","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 that a payment run can be executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1confirm/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs~1{payment_run_id}~1confirm/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment_runs/{payment_run_id}/confirm","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/confirm","href":"payment-runs/postpaymentrunsidconfirm","openApiOperationId":"postPaymentRunsIdConfirm","summary":"Confirm a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677"}},"schemaId":"schema_677"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_678"}},"schemaId":"schema_678"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_677","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_678","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_678"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/postpaymentrunsidconfirm"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/confirm"},{"label":"Get a payment run funding instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentrunsidfund","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentrunsidfund","metadata":{"seo":{"title":"Get a payment run funding instructions","description":"Start the the funding process of a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentRunsIdFund","name":"Get a payment run funding instructions","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1fund/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a payment run funding instructions","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":"Start the the funding process of a payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the funding source of the payment run by providing an id to an already linked account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the maximum payment amount constraints imposed by the bank that is providing the account, the payment run may be split in 2 or more groups. Note that you'll need to complete a funding process for each instruction returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1fund/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"linkedAccountIds","in":"query","schemaId":"schema_679","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the linked account, that is to be used as the funding source for the payment run."},"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 only one linked account per currency is supported."},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1fund/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/payment_runs/{payment_run_id}/fund","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[{"name":"linkedAccountIds","in":"query","required":true,"schemaId":"schema_679"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/fund","href":"payment-runs/getpaymentrunsidfund","openApiOperationId":"getPaymentRunsIdFund","summary":"Get a payment run funding instructions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_680"}},"schemaId":"schema_680"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_681"}},"schemaId":"schema_681"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1fund/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_680","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_680"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_681","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_681"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/getpaymentrunsidfund"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/fund"},{"label":"Cancel a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrunsidcancel","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrunsidcancel","metadata":{"seo":{"title":"Cancel a payment run","description":"Cancel a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postPaymentRunsIdCancel","name":"Cancel a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment run","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 a payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a payment run can be cancelled when it is in the states "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user roles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs~1{payment_run_id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment_runs/{payment_run_id}/cancel","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/cancel","href":"payment-runs/postpaymentrunsidcancel","openApiOperationId":"postPaymentRunsIdCancel","summary":"Cancel a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_682"}},"schemaId":"schema_682"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_682","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_682"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/postpaymentrunsidcancel"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/cancel"},{"label":"Cancel a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/putcancelpaymentrunpayment","routeSlug":"/products/payment-run/openapi/payment-runs/putcancelpaymentrunpayment","metadata":{"seo":{"title":"Cancel a payment","description":"Cancel a payment within a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putCancelPaymentRunPayment","name":"Cancel a payment","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel~1payments/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a payment within a payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a payment can be cancelled when it is in the state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"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":"Required user roles: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel~1payments/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs~1{payment_run_id}~1cancel~1payments/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_683"}},"schemaId":"schema_683","pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel~1payments/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/payment_runs/{payment_run_id}/cancel/payments","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_683"}},"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/cancel/payments","href":"payment-runs/putcancelpaymentrunpayment","openApiOperationId":"putCancelPaymentRunPayment","summary":"Cancel a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_683","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_683"}},"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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_684"}},"schemaId":"schema_684"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1cancel~1payments/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_684","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_684"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/putcancelpaymentrunpayment"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/cancel/payments"},{"label":"Restart a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postrestartpaymentrun","routeSlug":"/products/payment-run/openapi/payment-runs/postrestartpaymentrun","metadata":{"seo":{"title":"Restart a payment run","description":"Restart a payment run after it has entered status SCA_FAILED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postRestartPaymentRun","name":"Restart a payment run","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1restart/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restart a payment run","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":"Restart a payment run after it has entered status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"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":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1restart/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs~1{payment_run_id}~1restart/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment_runs/{payment_run_id}/restart","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/restart","href":"payment-runs/postrestartpaymentrun","openApiOperationId":"postRestartPaymentRun","summary":"Restart a payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_685"}},"schemaId":"schema_685"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1restart/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_685","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_685"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/postrestartpaymentrun"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/restart"},{"label":"Cancel a payment run group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postcancelpaymentrungroup","routeSlug":"/products/payment-run/openapi/payment-runs/postcancelpaymentrungroup","metadata":{"seo":{"title":"Cancel a payment run group","description":"Cancel a payment run groupNote that a payment run group can only be cancelled when it is in the state AWAITING_FUNDS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCancelPaymentRunGroup","name":"Cancel a payment run group","isWebhook":false,"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1group~1{group_reference}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a payment run group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a payment run group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that a payment run group can only be cancelled when it is in the state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"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":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"payment_run_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the payment run.","required":true},{"name":"group_reference","in":"path","schemaId":"schema_629","required":true}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1group~1{group_reference}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1payment_runs~1{payment_run_id}~1group~1{group_reference}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_673"},{"name":"group_reference","in":"path","required":true,"schemaId":"schema_629"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel","href":"payment-runs/postcancelpaymentrungroup","openApiOperationId":"postCancelPaymentRunGroup","summary":"Cancel a payment run group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_686"}},"schemaId":"schema_686"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1payment_runs~1{payment_run_id}~1group~1{group_reference}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_686","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_686"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs/postcancelpaymentrungroup"}],"panels":[]}]},"httpPath":"/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel"}],"content":{"contentType":"group","meta":{"name":"Payment runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment runs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Payment run contains a list of supplier payments. A Payment run can 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":"created by a user with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"confirmed by a user with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"funded by a user with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that the Controller user must have their mobile device enrolled to SCA."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before a payment run can be executed, it must be funded. Users with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role must link their company's bank account(s) that are represented as Linked Accounts, which than can be used as the funding source for a payment run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the bank's constraints it may not be possible to deposit the total amount of funds required for a payment run, in which case the payment run will be automatically split into funding groups. All funding groups must be funded and executed for the payment run to be marked as completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that even if the payment is created successfully, you still need to check its status in order to determine if it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/payment_runs","summary":"Create a payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/postpaymentrun","deprecated":false},{"title":"/v1/payment_runs","summary":"Get payment runs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/getpaymentruns","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}","summary":"Get a payment run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/getpaymentrunsid","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}","summary":"Update a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-runs/putpaymentrunsid","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/confirm","summary":"Confirm a payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/postpaymentrunsidconfirm","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/fund","summary":"Get a payment run funding instructions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-runs/getpaymentrunsidfund","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/cancel","summary":"Cancel a payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/postpaymentrunsidcancel","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/cancel/payments","summary":"Cancel a payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-runs/putcancelpaymentrunpayment","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/restart","summary":"Restart a payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/postrestartpaymentrun","deprecated":false},{"title":"/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel","summary":"Cancel a payment run group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs/postcancelpaymentrungroup","deprecated":false}]}]}]}]}},{"type":"separator","label":"Instruments","content":null},{"type":"group","label":"Linked Accounts","link":"/products/payment-run/openapi/linked-accounts","routeSlug":"/products/payment-run/openapi/linked-accounts","items":[{"label":"Get Linked accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/getlinkedaccounts","routeSlug":"/products/payment-run/openapi/linked-accounts/getlinkedaccounts","metadata":{"seo":{"title":"Get Linked accounts","description":"Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLinkedAccounts","name":"Get Linked accounts","isWebhook":false,"pointer":"/paths/~1v1~1linked_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Linked accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/linked_accounts","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/linked_accounts","href":"linked-accounts/getlinkedaccounts","openApiOperationId":"getLinkedAccounts","summary":"Get Linked accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_687"}},"schemaId":"schema_687"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1linked_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_687","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_687"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts/getlinkedaccounts"}],"panels":[]}]},"httpPath":"/v1/linked_accounts"},{"label":"Get Linked account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/getlinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/getlinkedaccountsid","metadata":{"seo":{"title":"Get Linked account","description":"Retrieves a linked account of the buyer that the logged-in user belongs to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLinkedAccountsId","name":"Get Linked account","isWebhook":false,"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Linked 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":"Retrieves a linked account of the buyer that the logged-in user belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"linked_account_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the linked account.","required":true}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/linked_accounts/{linked_account_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"linked_account_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","503","default"],"pointer":"/v1/linked_accounts/{linked_account_id}","href":"linked-accounts/getlinkedaccountsid","openApiOperationId":"getLinkedAccountsId","summary":"Get Linked account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}},"schemaId":"schema_688"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts/getlinkedaccountsid"}],"panels":[]}]},"httpPath":"/v1/linked_accounts/{linked_account_id}"},{"label":"Update a linked account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/patchlinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/patchlinkedaccountsid","metadata":{"seo":{"title":"Update a linked account","description":"Updates properties of a linked account such as friendly name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLinkedAccountsId","name":"Update a linked account","isWebhook":false,"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a linked 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":"Updates properties of a linked account such as friendly name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"linked_account_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the linked account.","required":true}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1linked_accounts~1{linked_account_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_689"}},"schemaId":"schema_689","pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/linked_accounts/{linked_account_id}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"linked_account_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_689"}},"responseCodes":["200","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/linked_accounts/{linked_account_id}","href":"linked-accounts/patchlinkedaccountsid","openApiOperationId":"patchLinkedAccountsId","summary":"Update a linked account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_689","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_689"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}},"schemaId":"schema_688"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_690"}},"schemaId":"schema_690"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_690","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_690"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts/patchlinkedaccountsid"}],"panels":[]}]},"httpPath":"/v1/linked_accounts/{linked_account_id}"},{"label":"Unlink a linked account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/unlinklinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/unlinklinkedaccountsid","metadata":{"seo":{"title":"Unlink a linked account","description":"Unlinks a linked account identified by the linked_account_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkLinkedAccountsId","name":"Unlink a linked account","isWebhook":false,"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}~1unlink/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink a linked 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":"Unlinks a linked account identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_account_id"},"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 action is not reversible and if the buyer wants to use this linked account again to fund payment runs, they will have to re-link the account. More information on how to link an account can be found "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.weavr.io/payment-run/instruments/link-account/"},"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":"Details of an unlinked account, can still be retrieved via the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLinkedAccounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get linked accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLinkedAccountsId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get linked account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required user role: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"linked_account_id","in":"path","schemaId":"schema_673","description":"The unique identifier of the linked account.","required":true}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}~1unlink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"idempotency-ref","in":"header","schemaId":"schema_629","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/~1v1~1linked_accounts~1{linked_account_id}~1unlink/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/linked_accounts/{linked_account_id}/unlink","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"linked_account_id","in":"path","required":true,"schemaId":"schema_673"}],"query":[],"querystring":[],"header":[{"name":"idempotency-ref","in":"header","required":false,"schemaId":"schema_629"}],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","413","422","429","500","503","default"],"pointer":"/v1/linked_accounts/{linked_account_id}/unlink","href":"linked-accounts/unlinklinkedaccountsid","openApiOperationId":"unlinkLinkedAccountsId","summary":"Unlink a linked account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}},"schemaId":"schema_688"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_690"}},"schemaId":"schema_690"},{"code":"413","description":"Content Too Large","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"422","description":"Unprocessable Entity","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1linked_accounts~1{linked_account_id}~1unlink/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_688","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_688"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_690","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_690"}}},{"code":"413"},{"code":"422"},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts/unlinklinkedaccountsid"}],"panels":[]}]},"httpPath":"/v1/linked_accounts/{linked_account_id}/unlink"}],"content":{"contentType":"group","meta":{"name":"Linked Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Linked accounts represent bank accounts that the buyer has with other banks. Once set up, they are used to fund payment runs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/linked_accounts","summary":"Get Linked accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/linked-accounts/getlinkedaccounts","deprecated":false},{"title":"/v1/linked_accounts/{linked_account_id}","summary":"Get Linked account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/linked-accounts/getlinkedaccountsid","deprecated":false},{"title":"/v1/linked_accounts/{linked_account_id}","summary":"Update a linked account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/linked-accounts/patchlinkedaccountsid","deprecated":false},{"title":"/v1/linked_accounts/{linked_account_id}/unlink","summary":"Unlink a linked account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linked-accounts/unlinklinkedaccountsid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Institutions","content":null},{"type":"group","label":"Institutions","link":"/products/payment-run/openapi/institutions","routeSlug":"/products/payment-run/openapi/institutions","items":[{"label":"Get Institutions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/institutions/getinstitutions","routeSlug":"/products/payment-run/openapi/institutions/getinstitutions","metadata":{"seo":{"title":"Get Institutions","description":"Retrieves the Institutions supported by Embedded Payment Run. The response payload should list all the institutions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstitutions","name":"Get Institutions","isWebhook":false,"pointer":"/paths/~1v1~1institutions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Institutions","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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Institutions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported by Embedded Payment Run. The response payload should list all the institutions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment runs are funded from linked bank accounts provided by one of the supported institutions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend that you enable Buyers to check if their banks are supported before they start the registration and onboarding process."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_629","description":"Filter by country"},{"name":"institutionIds","in":"query","schemaId":"schema_691","description":"Filter by institution ID"},{"name":"institutionName","in":"query","schemaId":"schema_629","description":"Filter by institution name"},{"name":"market","in":"query","schemaId":"schema_692","description":"Filter by market"},{"name":"offset","in":"query","schemaId":"schema_693"},{"name":"limit","in":"query","schemaId":"schema_694"}],"pointer":"/paths/~1v1~1institutions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/institutions","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":false,"schemaId":"schema_629"},{"name":"institutionIds","in":"query","required":false,"schemaId":"schema_691"},{"name":"institutionName","in":"query","required":false,"schemaId":"schema_629"},{"name":"market","in":"query","required":false,"schemaId":"schema_692"},{"name":"offset","in":"query","required":false,"schemaId":"schema_693"},{"name":"limit","in":"query","required":false,"schemaId":"schema_694"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","503","default"],"pointer":"/v1/institutions","href":"institutions/getinstitutions","openApiOperationId":"getInstitutions","summary":"Get Institutions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_695"}},"schemaId":"schema_695"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1v1~1institutions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_695","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_695"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/institutions/getinstitutions"}],"panels":[]}]},"httpPath":"/v1/institutions"}],"content":{"contentType":"group","meta":{"name":"Institutions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Institutions","showPageActions":true},{"nodeType":"markdoc","content":"Institutions supported by Embedded Payment Run."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/institutions","summary":"Get Institutions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/institutions/getinstitutions","deprecated":false}]}]}]}]}},{"type":"separator","label":"Simulators","content":null},{"type":"group","label":"Simulator","link":"/products/payment-run/openapi/simulator","routeSlug":"/products/payment-run/openapi/simulator","items":[{"label":"Simulate Fund a Payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postfundpaymentrungroup","routeSlug":"/products/payment-run/openapi/simulator/postfundpaymentrungroup","metadata":{"seo":{"title":"Simulate Fund a Payment run","description":"Simulate funding a payment run using a linked account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postFundPaymentRunGroup","name":"Simulate Fund a Payment run","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1payment_runs~1{payment_run_id}~1fund_group~1{reference}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate Fund a Payment run","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":"Simulate funding a payment run using a linked account."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_run_id","in":"path","schemaId":"schema_696","required":true},{"name":"reference","in":"path","schemaId":"schema_629","required":true}],"pointer":"/paths/~1simulate~1v1~1payment_runs~1{payment_run_id}~1fund_group~1{reference}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_696"},{"name":"reference","in":"path","required":true,"schemaId":"schema_629"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["201","400","401","403","404","409","500","503","default"],"pointer":"/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}","href":"simulator/postfundpaymentrungroup","openApiOperationId":"postFundPaymentRunGroup","summary":"Simulate Fund a Payment run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"201","description":"Success"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697"}},"schemaId":"schema_697"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1payment_runs~1{payment_run_id}~1fund_group~1{reference}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_697","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/postfundpaymentrungroup"}],"panels":[]}]},"httpPath":"/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}"},{"label":"Simulate Creating a Linked Account via Open Banking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postlinkedaccounts","routeSlug":"/products/payment-run/openapi/simulator/postlinkedaccounts","metadata":{"seo":{"title":"Simulate Creating a Linked Account via Open Banking","description":"The Linked Account Simulator allows you to create a simulated linked account that can be used for funding payment runs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postLinkedAccounts","name":"Simulate Creating a Linked Account via Open Banking","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1linked_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate Creating a Linked Account via Open Banking","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 Linked Account Simulator allows you to create a simulated linked account that can be used for funding payment runs."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"schemaId":"schema_698","pointer":"/paths/~1simulate~1v1~1linked_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/linked_accounts","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_698"}},"responseCodes":["201","400","401","403","409","500","503","default"],"pointer":"/simulate/v1/linked_accounts","href":"simulator/postlinkedaccounts","openApiOperationId":"postLinkedAccounts","summary":"Simulate Creating a Linked Account via Open Banking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_698","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_698"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_699"}},"schemaId":"schema_699"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697"}},"schemaId":"schema_697"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1linked_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_699","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_699"}}},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"409","schemaId":"schema_697","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_697"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/postlinkedaccounts"}],"panels":[]}]},"httpPath":"/simulate/v1/linked_accounts"},{"label":"Simulate Control Check via Test Funding Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postsimulatelinkedaccountfundverification","routeSlug":"/products/payment-run/openapi/simulator/postsimulatelinkedaccountfundverification","metadata":{"seo":{"title":"Simulate Control Check via Test Funding Transaction","description":"Simulate Control Check via Test Funding Transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSimulateLinkedAccountFundVerification","name":"Simulate Control Check via Test Funding Transaction","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1linked_accounts~1{linked_account_id}~1fund/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate Control Check via Test Funding Transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Simulate Control Check via Test Funding Transaction"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"linked_account_id","in":"path","schemaId":"schema_696","required":true}],"pointer":"/paths/~1simulate~1v1~1linked_accounts~1{linked_account_id}~1fund/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/linked_accounts/{linked_account_id}/fund","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"linked_account_id","in":"path","required":true,"schemaId":"schema_696"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/simulate/v1/linked_accounts/{linked_account_id}/fund","href":"simulator/postsimulatelinkedaccountfundverification","openApiOperationId":"postSimulateLinkedAccountFundVerification","summary":"Simulate Control Check via Test Funding Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}},"schemaId":"schema_700"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1linked_accounts~1{linked_account_id}~1fund/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_700","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/postsimulatelinkedaccountfundverification"}],"panels":[]}]},"httpPath":"/simulate/v1/linked_accounts/{linked_account_id}/fund"},{"label":"Simulate Buyer KYB Verify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/verifybuyerkyb","routeSlug":"/products/payment-run/openapi/simulator/verifybuyerkyb","metadata":{"seo":{"title":"Simulate Buyer KYB Verify","description":"Simulates due diligence (KYB) for Buyers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyBuyerKyb","name":"Simulate Buyer KYB Verify","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1buyers~1{buyer_id}~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate Buyer KYB Verify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates due diligence (KYB) for Buyers."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"buyer_id","in":"path","schemaId":"schema_629","required":true}],"pointer":"/paths/~1simulate~1v1~1buyers~1{buyer_id}~1verify/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/buyers/{buyer_id}/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"buyer_id","in":"path","required":true,"schemaId":"schema_629"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500","503","default"],"pointer":"/simulate/v1/buyers/{buyer_id}/verify","href":"simulator/verifybuyerkyb","openApiOperationId":"verifyBuyerKyb","summary":"Simulate Buyer KYB Verify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1buyers~1{buyer_id}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/verifybuyerkyb"}],"panels":[]}]},"httpPath":"/simulate/v1/buyers/{buyer_id}/verify"},{"label":"Simulate AIS consent status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postsimulateconsentstatuschange","routeSlug":"/products/payment-run/openapi/simulator/postsimulateconsentstatuschange","metadata":{"seo":{"title":"Simulate AIS consent status change","description":"Simulate AIS consent status change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSimulateConsentStatusChange","name":"Simulate AIS consent status change","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1consents~1{linked_account_id}~1change_status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate AIS consent status change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulate AIS consent status change."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"linked_account_id","in":"path","schemaId":"schema_696","required":true}],"pointer":"/paths/~1simulate~1v1~1consents~1{linked_account_id}~1change_status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_701"}},"schemaId":"schema_701","pointer":"/paths/~1simulate~1v1~1consents~1{linked_account_id}~1change_status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/consents/{linked_account_id}/change_status","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"linked_account_id","in":"path","required":true,"schemaId":"schema_696"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_701"}},"responseCodes":["204","400","401","403","404","409","500","503","default"],"pointer":"/simulate/v1/consents/{linked_account_id}/change_status","href":"simulator/postsimulateconsentstatuschange","openApiOperationId":"postSimulateConsentStatusChange","summary":"Simulate AIS consent status change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_701","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_701"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702"}},"schemaId":"schema_702"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1consents~1{linked_account_id}~1change_status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_702","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702"}}},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/postsimulateconsentstatuschange"}],"panels":[]}]},"httpPath":"/simulate/v1/consents/{linked_account_id}/change_status"},{"label":"Simulate issuing a Payment Run SCA Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/issuepaymentrunchallengesimulate","routeSlug":"/products/payment-run/openapi/simulator/issuepaymentrunchallengesimulate","metadata":{"seo":{"title":"Simulate issuing a Payment Run SCA Challenge","description":"Simulates issuing the SCA challenge for a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"issuePaymentRunChallengeSimulate","name":"Simulate issuing a Payment Run SCA Challenge","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate issuing a Payment Run SCA Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates issuing the SCA challenge for a payment run."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true},{"name":"payment_run_id","in":"path","schemaId":"schema_696","description":"The unique identifier for the payment run.","required":true}],"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"},{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_696"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}","href":"simulator/issuepaymentrunchallengesimulate","openApiOperationId":"issuePaymentRunChallengeSimulate","summary":"Simulate issuing a Payment Run SCA Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/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":"No Content"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_703"}},"schemaId":"schema_703"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_703","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_703"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/issuepaymentrunchallengesimulate"}],"panels":[]}]},"httpPath":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}"},{"label":"Simulate verifying a payment run SCA Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/verifypaymentrunchallengesimulate","routeSlug":"/products/payment-run/openapi/simulator/verifypaymentrunchallengesimulate","metadata":{"seo":{"title":"Simulate verifying a payment run SCA Challenge","description":"Simulates verifying the SCA challenge for a payment run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyPaymentRunChallengeSimulate","name":"Simulate verifying a payment run SCA Challenge","isWebhook":false,"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulate verifying a payment run SCA Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates verifying the SCA challenge for a payment run."},"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":"This endpoint will only function in Sandbox and should not be used in the Live environment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"api-key","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page."},{"name":"authToken","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":"components/schemas/SCAOtpChannel","description":"The unique identifier for the channel.","required":true},{"name":"payment_run_id","in":"path","schemaId":"schema_696","description":"The unique identifier for the payment run.","required":true}],"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_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_704"}},"schemaId":"schema_704","pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"channel","in":"path","required":true,"schemaId":"components/schemas/SCAOtpChannel"},{"name":"payment_run_id","in":"path","required":true,"schemaId":"schema_696"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"api-key","in":"header"},{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_704"}},"responseCodes":["204","400","401","403","404","409","429","500","503","default"],"pointer":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify","href":"simulator/verifypaymentrunchallengesimulate","openApiOperationId":"verifyPaymentRunChallengeSimulate","summary":"Simulate verifying a payment run SCA Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_704","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_704"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request Error - Your request is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"401","description":"Unauthorized - Your credentials or access token are invalid.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"403","description":"Forbidden - Access to the requested resource or action is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"404","description":"Not found - The requested resource couldn't be found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705"},{"code":"429","description":"Too many requests.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}},"x-ratelimit-limit":{"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":[]}]}]}],"required":true,"schema":{"type":"string"}},"x-ratelimit-reset":{"description":"The number of seconds until the window is reset.","required":true,"schema":{"minimum":0,"type":"integer","format":"int32"}}},"headerSchemaId":"schema_614"},{"code":"500","description":"Internal Server Error - There is a problem with the server. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"503","description":"Service Unavailable - We're temporarily offline for maintenance. Please try again later.","headers":{"request-ref":{"description":"A request identifier. Providing this reference when contacting our support team will help us investigate your query.","required":true,"schema":{"type":"string"}}},"headerSchemaId":"schema_610"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615"}],"pointer":"/paths/~1simulate~1v1~1payment_run_sca~1{payment_run_id}~1challenges~1otp~1{channel}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_611"}}},{"code":"401"},{"code":"403","schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_612"}}},{"code":"404","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}},{"code":"409","schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_705"}}},{"code":"429"},{"code":"500"},{"code":"503"},{"code":"default","schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_615"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/simulator/verifypaymentrunchallengesimulate"}],"panels":[]}]},"httpPath":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify"}],"content":{"contentType":"group","meta":{"name":"Simulator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Simulator","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":"Simulators enable you to trigger processes in Sandbox that in Production are triggered from an external action rather than from your application. this way you can test scenarios that otherwise you would only encounter in the Live environment."},"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: These endpoints are only available on Sandbox and won’t work in the Live environment."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}","summary":"Simulate Fund a Payment run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/postfundpaymentrungroup","deprecated":false},{"title":"/simulate/v1/linked_accounts","summary":"Simulate Creating a Linked Account via Open Banking","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/postlinkedaccounts","deprecated":false},{"title":"/simulate/v1/linked_accounts/{linked_account_id}/fund","summary":"Simulate Control Check via Test Funding Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/postsimulatelinkedaccountfundverification","deprecated":false},{"title":"/simulate/v1/buyers/{buyer_id}/verify","summary":"Simulate Buyer KYB Verify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/verifybuyerkyb","deprecated":false},{"title":"/simulate/v1/consents/{linked_account_id}/change_status","summary":"Simulate AIS consent status change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/postsimulateconsentstatuschange","deprecated":false},{"title":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}","summary":"Simulate issuing a Payment Run SCA Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/issuepaymentrunchallengesimulate","deprecated":false},{"title":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify","summary":"Simulate verifying a payment run SCA Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/simulator/verifypaymentrunchallengesimulate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Events","content":null},{"type":"group","label":"Buyers","link":"/products/payment-run/openapi/buyers-webhooks","routeSlug":"/products/payment-run/openapi/buyers-webhooks","items":[{"label":"Buyer KYB status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_kyb_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_kyb_watch","metadata":{"seo":{"title":"Buyer KYB status update","description":"Notification that the KYB status of a buyer identity has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_buyer_kyb_watch","name":"Buyer KYB status update","isWebhook":true,"pointer":"/paths/buyerKYBWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyer KYB status update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that the KYB status of a buyer identity has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/buyerKYBWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_707"}},"schemaId":"schema_707","pointer":"/paths/buyerKYBWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"buyerKYBWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_707"}},"responseCodes":["200"],"pointer":"buyerKYBWatch","href":"buyers-webhooks/webhook_buyer_kyb_watch","openApiOperationId":"webhook_buyer_kyb_watch","summary":"Buyer KYB status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_707","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_707"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/buyerKYBWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers-webhooks/webhook_buyer_kyb_watch"}],"panels":[]}]},"httpPath":"buyerKYBWatch"},{"label":"Buyer Beneficiary status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","metadata":{"seo":{"title":"Buyer Beneficiary status update","description":"Notification that the verification status of a buyer beneficiary has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_buyer_beneficiary_kyb_watch","name":"Buyer Beneficiary status update","isWebhook":true,"pointer":"/paths/buyerBeneficiaryStatusWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyer Beneficiary status update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that the verification status of a buyer beneficiary has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/buyerBeneficiaryStatusWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_708"}},"schemaId":"schema_708","pointer":"/paths/buyerBeneficiaryStatusWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"buyerBeneficiaryStatusWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_708"}},"responseCodes":["200"],"pointer":"buyerBeneficiaryStatusWatch","href":"buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","openApiOperationId":"webhook_buyer_beneficiary_kyb_watch","summary":"Buyer Beneficiary status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_708","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_708"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/buyerBeneficiaryStatusWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch"}],"panels":[]}]},"httpPath":"buyerBeneficiaryStatusWatch"},{"label":"Buyer update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_watch","metadata":{"seo":{"title":"Buyer update","description":"Notification that a buyer has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_buyer_watch","name":"Buyer update","isWebhook":true,"pointer":"/paths/buyerWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyer update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a buyer has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/buyerWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_709"}},"schemaId":"schema_709","pointer":"/paths/buyerWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"buyerWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_709"}},"responseCodes":["200"],"pointer":"buyerWatch","href":"buyers-webhooks/webhook_buyer_watch","openApiOperationId":"webhook_buyer_watch","summary":"Buyer update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_709","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_709"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/buyerWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers-webhooks/webhook_buyer_watch"}],"panels":[]}]},"httpPath":"buyerWatch"},{"label":"Buyer deactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_deactivated_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_deactivated_watch","metadata":{"seo":{"title":"Buyer deactivation","description":"Notification that a buyer identity has been deactivated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_buyer_deactivated_watch","name":"Buyer deactivation","isWebhook":true,"pointer":"/paths/buyerDeactivatedWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyer deactivation","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a buyer identity has been deactivated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/buyerDeactivatedWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"schemaId":"schema_710","pointer":"/paths/buyerDeactivatedWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"buyerDeactivatedWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_710"}},"responseCodes":["200"],"pointer":"buyerDeactivatedWatch","href":"buyers-webhooks/webhook_buyer_deactivated_watch","openApiOperationId":"webhook_buyer_deactivated_watch","summary":"Buyer deactivation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_710","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/buyerDeactivatedWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/buyers-webhooks/webhook_buyer_deactivated_watch"}],"panels":[]}]},"httpPath":"buyerDeactivatedWatch"}],"content":{"contentType":"group","meta":{"name":"Buyers Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Buyers","showPageActions":true},{"nodeType":"markdoc","content":"Buyers are identities representing companies. Once on-boarded, Buyers can create and manage their own instruments via your application."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"buyerKYBWatch","summary":"Buyer KYB status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers-webhooks/webhook_buyer_kyb_watch","deprecated":false},{"title":"buyerBeneficiaryStatusWatch","summary":"Buyer Beneficiary status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","deprecated":false},{"title":"buyerWatch","summary":"Buyer update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers-webhooks/webhook_buyer_watch","deprecated":false},{"title":"buyerDeactivatedWatch","summary":"Buyer deactivation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/buyers-webhooks/webhook_buyer_deactivated_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment runs","link":"/products/payment-run/openapi/payment-runs-webhooks","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks","items":[{"label":"Payment Run Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunwatch","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunwatch","metadata":{"seo":{"title":"Payment Run Update","description":"Notification that the status of a Payment Run has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookPaymentRunWatch","name":"Payment Run Update","isWebhook":true,"pointer":"/paths/paymentRunWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Run Update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that the status of a Payment Run has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/paymentRunWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_711"}},"schemaId":"schema_711","pointer":"/paths/paymentRunWatch/post/requestBody","description":"Payment run event triggered when the status changes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"paymentRunWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_711"}},"responseCodes":["200"],"pointer":"paymentRunWatch","href":"payment-runs-webhooks/webhookpaymentrunwatch","openApiOperationId":"webhookPaymentRunWatch","summary":"Payment Run Update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_711","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_711"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/paymentRunWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs-webhooks/webhookpaymentrunwatch"}],"panels":[]}]},"httpPath":"paymentRunWatch"},{"label":"Payment Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunpaymentwatch","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunpaymentwatch","metadata":{"seo":{"title":"Payment Update","description":"Notification that the status of a payment in the Payment Run has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookPaymentRunPaymentWatch","name":"Payment Update","isWebhook":true,"pointer":"/paths/paymentRunPaymentWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that the status of a payment in the Payment Run has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/paymentRunPaymentWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712","pointer":"/paths/paymentRunPaymentWatch/post/requestBody","description":"Event triggered when the status of a payment run payment changes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"paymentRunPaymentWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_712"}},"responseCodes":["200"],"pointer":"paymentRunPaymentWatch","href":"payment-runs-webhooks/webhookpaymentrunpaymentwatch","openApiOperationId":"webhookPaymentRunPaymentWatch","summary":"Payment Update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_712"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/paymentRunPaymentWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs-webhooks/webhookpaymentrunpaymentwatch"}],"panels":[]}]},"httpPath":"paymentRunPaymentWatch"},{"label":"Payment Run Group Not Funded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrungroupnotfunded","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrungroupnotfunded","metadata":{"seo":{"title":"Payment Run Group Not Funded","description":"Notification that a group expecting funds has not been funded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookpaymentRunGroupNotFunded","name":"Payment Run Group Not Funded","isWebhook":true,"pointer":"/paths/paymentRunGroupNotFunded/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Run Group Not Funded","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a group expecting funds has not been funded."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/paymentRunGroupNotFunded/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_713"}},"schemaId":"schema_713","pointer":"/paths/paymentRunGroupNotFunded/post/requestBody","description":"Event triggered when the status of a payment run payment changes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"paymentRunGroupNotFunded","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_713"}},"responseCodes":["200"],"pointer":"paymentRunGroupNotFunded","href":"payment-runs-webhooks/webhookpaymentrungroupnotfunded","openApiOperationId":"webhookpaymentRunGroupNotFunded","summary":"Payment Run Group Not Funded"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_713","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_713"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/paymentRunGroupNotFunded/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-runs-webhooks/webhookpaymentrungroupnotfunded"}],"panels":[]}]},"httpPath":"paymentRunGroupNotFunded"}],"content":{"contentType":"group","meta":{"name":"Payment runs Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment runs","showPageActions":true},{"nodeType":"markdoc","content":"Notification that the Payment Run and payment statuses have been updated."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"paymentRunWatch","summary":"Payment Run Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs-webhooks/webhookpaymentrunwatch","deprecated":false},{"title":"paymentRunPaymentWatch","summary":"Payment Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs-webhooks/webhookpaymentrunpaymentwatch","deprecated":false},{"title":"paymentRunGroupNotFunded","summary":"Payment Run Group Not Funded","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-runs-webhooks/webhookpaymentrungroupnotfunded","deprecated":false}]}]}]}]}},{"type":"group","label":"Linked Accounts","link":"/products/payment-run/openapi/linked-accounts-webhooks","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks","items":[{"label":"Linked Account Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/linked-accounts-webhooks/webhooklinkedaccountwatch","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks/webhooklinkedaccountwatch","metadata":{"seo":{"title":"Linked Account Update","description":"Notification of the status update for a linked Account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookLinkedAccountWatch","name":"Linked Account Update","isWebhook":true,"pointer":"/paths/linkedAccountWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Account Update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification of the status update for a linked Account."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/linkedAccountWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714"}},"schemaId":"schema_714","pointer":"/paths/linkedAccountWatch/post/requestBody","description":"Payment run event triggered when the status changes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"linkedAccountWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_714"}},"responseCodes":["200"],"pointer":"linkedAccountWatch","href":"linked-accounts-webhooks/webhooklinkedaccountwatch","openApiOperationId":"webhookLinkedAccountWatch","summary":"Linked Account Update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_714","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/linkedAccountWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts-webhooks/webhooklinkedaccountwatch"}],"panels":[]}]},"httpPath":"linkedAccountWatch"},{"label":"Linked Account Expiring Soon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/linked-accounts-webhooks/linkedaccountexpiringsoonwatch","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks/linkedaccountexpiringsoonwatch","metadata":{"seo":{"title":"Linked Account Expiring Soon","description":"Notification when a linked account is expiring soon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkedAccountExpiringSoonWatch","name":"Linked Account Expiring Soon","isWebhook":true,"pointer":"/paths/linkedAccountExpiringSoonWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Account Expiring Soon","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification when a linked account is expiring soon."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/linkedAccountExpiringSoonWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715","pointer":"/paths/linkedAccountExpiringSoonWatch/post/requestBody","description":"Payment run event triggered when the status changes"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"linkedAccountExpiringSoonWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_715"}},"responseCodes":["200"],"pointer":"linkedAccountExpiringSoonWatch","href":"linked-accounts-webhooks/linkedaccountexpiringsoonwatch","openApiOperationId":"linkedAccountExpiringSoonWatch","summary":"Linked Account Expiring Soon"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_715"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/linkedAccountExpiringSoonWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/linked-accounts-webhooks/linkedaccountexpiringsoonwatch"}],"panels":[]}]},"httpPath":"linkedAccountExpiringSoonWatch"}],"content":{"contentType":"group","meta":{"name":"Linked Accounts Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linked Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Notification that the status of a Linked Account has been updated."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"linkedAccountWatch","summary":"Linked Account Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linked-accounts-webhooks/webhooklinkedaccountwatch","deprecated":false},{"title":"linkedAccountExpiringSoonWatch","summary":"Linked Account Expiring Soon","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linked-accounts-webhooks/linkedaccountexpiringsoonwatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Login","link":"/products/payment-run/openapi/tokens-webhooks","routeSlug":"/products/payment-run/openapi/tokens-webhooks","items":[{"label":"Login attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/tokens-webhooks/webhook-login-watch","routeSlug":"/products/payment-run/openapi/tokens-webhooks/webhook-login-watch","metadata":{"seo":{"title":"Login attempt","description":"Notification that a login attempt was completed successfully or declined."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook-login-watch","name":"Login attempt","isWebhook":true,"pointer":"/paths/loginWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login attempt","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a login attempt was completed successfully or declined.\n"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/loginWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_716"}},"schemaId":"schema_716","pointer":"/paths/loginWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"loginWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_716"}},"responseCodes":["200"],"pointer":"loginWatch","href":"tokens-webhooks/webhook-login-watch","openApiOperationId":"webhook-login-watch","summary":"Login attempt"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_716","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_716"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/loginWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tokens-webhooks/webhook-login-watch"}],"panels":[]}]},"httpPath":"loginWatch"}],"content":{"contentType":"group","meta":{"name":"Tokens Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login","showPageActions":true},{"nodeType":"markdoc","content":"Tokens webhooks"}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"loginWatch","summary":"Login attempt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tokens-webhooks/webhook-login-watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Stepup","link":"/products/payment-run/openapi/stepup-webhooks","routeSlug":"/products/payment-run/openapi/stepup-webhooks","items":[{"label":"Step-up status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/stepup-webhooks/stepup_watch","routeSlug":"/products/payment-run/openapi/stepup-webhooks/stepup_watch","metadata":{"seo":{"title":"Step-up status","description":"Notification that a step-up has been completed or declined."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stepup_watch","name":"Step-up status","isWebhook":true,"pointer":"/paths/stepupWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Step-up status","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a step-up has been completed or declined."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/stepupWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717"}},"schemaId":"schema_717","pointer":"/paths/stepupWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"stepupWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_717"}},"responseCodes":["200"],"pointer":"stepupWatch","href":"stepup-webhooks/stepup_watch","openApiOperationId":"stepup_watch","summary":"Step-up status"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_717","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_717"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/stepupWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stepup-webhooks/stepup_watch"}],"panels":[]}]},"httpPath":"stepupWatch"}],"content":{"contentType":"group","meta":{"name":"Stepup Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stepup","showPageActions":true},{"nodeType":"markdoc","content":"Notification that a step-up has been completed or declined."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"stepupWatch","summary":"Step-up status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stepup-webhooks/stepup_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication Factors","link":"/products/payment-run/openapi/authentication-factors-webhooks","routeSlug":"/products/payment-run/openapi/authentication-factors-webhooks","items":[{"label":"Enrolment status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/authentication-factors-webhooks/authentication_factors_watch","routeSlug":"/products/payment-run/openapi/authentication-factors-webhooks/authentication_factors_watch","metadata":{"seo":{"title":"Enrolment status","description":"Notification that an enrolment has been accepted or declined."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authentication_factors_watch","name":"Enrolment status","isWebhook":true,"pointer":"/paths/authenticationFactorsWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrolment status","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that an enrolment has been accepted or declined."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/authenticationFactorsWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"schemaId":"schema_718","pointer":"/paths/authenticationFactorsWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"authenticationFactorsWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_718"}},"responseCodes":["200"],"pointer":"authenticationFactorsWatch","href":"authentication-factors-webhooks/authentication_factors_watch","openApiOperationId":"authentication_factors_watch","summary":"Enrolment status"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_718","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/authenticationFactorsWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors-webhooks/authentication_factors_watch"}],"panels":[]}]},"httpPath":"authenticationFactorsWatch"}],"content":{"contentType":"group","meta":{"name":"Authentication Factors Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication Factors","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":"Notification of the Authentication Factors that are used for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"authenticationFactorsWatch","summary":"Enrolment status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors-webhooks/authentication_factors_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/products/payment-run/openapi/transactions-webhooks","routeSlug":"/products/payment-run/openapi/transactions-webhooks","items":[{"label":"Sweeping status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/transactions-webhooks/sweeping_watch","routeSlug":"/products/payment-run/openapi/transactions-webhooks/sweeping_watch","metadata":{"seo":{"title":"Sweeping status update","description":"Notification that the sweeping status has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sweeping_watch","name":"Sweeping status update","isWebhook":true,"pointer":"/paths/sweepingWatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sweeping status update","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that the sweeping status has been updated.\n\nSweeping represents transactions that return money to the source account. It may be triggered by unmatched incoming transaction or by failed payment run payments.\n"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_629","description":"A call reference generated by the caller and unique to the caller\nto provide correlation between the caller and system with a maximum length\nof 255\n"},{"name":"published-timestamp","in":"header","schemaId":"schema_706","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_629","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},{"name":"signature-v2","in":"header","schemaId":"schema_629","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"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the request body, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, all concatenated without spaces, and signed using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/sweepingWatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719","pointer":"/paths/sweepingWatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"sweepingWatch","servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_629","style":"simple","explode":false},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_706","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_629","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_719"}},"responseCodes":["200"],"pointer":"sweepingWatch","href":"transactions-webhooks/sweeping_watch","openApiOperationId":"sweeping_watch","summary":"Sweeping status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","description":"Mock server","isMockServer":true}],"schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_719"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/sweepingWatch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-webhooks/sweeping_watch"}],"panels":[]}]},"httpPath":"sweepingWatch"}],"content":{"contentType":"group","meta":{"name":"Transactions Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Notification that the status of a transaction has been updated."}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"sweepingWatch","summary":"Sweeping status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions-webhooks/sweeping_watch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/IdentityId":{"id":"components/schemas/IdentityId","kind":"json-schema","title":"IdentityId","data":{"type":"object","required":["type","id"],"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.","minLength":6,"maxLength":6,"pattern":"^[0-9]*$"}},"components/schemas/PasswordInfo":{"id":"components/schemas/PasswordInfo","kind":"json-schema","title":"PasswordInfo","data":{"type":"object","required":["buyerId"],"description":"Additional information related to the user's password.","properties":{"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The buyer to which the user's password information belongs to."},"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/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/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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}},"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"]}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672"}},"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.","minLength":6,"maxLength":6,"pattern":"^[0-9]+$"}},"components/schemas/BeneficiaryTrustLevel":{"id":"components/schemas/BeneficiaryTrustLevel","kind":"json-schema","title":"BeneficiaryTrustLevel","data":{"type":"string","description":"The value that determines whether a Supplier is trusted or not.","enum":["TRUSTED"]}},"components/schemas/BusinessSupplierType":{"id":"components/schemas/BusinessSupplierType","kind":"json-schema","title":"BusinessSupplierType","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"supplierDetails.bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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/ConsumerSupplierType":{"id":"components/schemas/ConsumerSupplierType","kind":"json-schema","title":"ConsumerSupplierType","data":{"required":["fullName"],"type":"object","properties":{"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 supplier name. The allowed length and pattern is dependent on the supplier details type:"},"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":"SepaBankDetails"},"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":"FasterPaymentsBankDetails"},"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":[]}]}]}]}}}},"schema_608":{"kind":"json-schema","data":{"required":["email","password"],"type":"object","properties":{"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"password":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}}},"id":"schema_608"},"schema_609":{"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":{"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":["AUTH","ACCESS"]},"identity":{"description":"The identity to which the logged-in user belongs to.","type":"object","required":["type","id"],"properties":{"type":{"enum":["BUYER"],"type":"string","description":"Indicates the identity type."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier for the identity."}}},"credentials":{"description":"The unique identifier for the logged-in user.","required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ADMIN","USER"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}}}},"id":"schema_609"},"schema_610":{"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_610"},"schema_611":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"maxLength":255,"type":"string","description":"When present helps to identify and fix the problem."},"syntaxErrors":{"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"]}}}}}}}},"id":"schema_611"},"schema_612":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INSUFFICIENT_PERMISSIONS"]}}},"id":"schema_612"},"schema_613":{"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_613"},"schema_614":{"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_614"},"schema_615":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}},"id":"schema_615"},"schema_616":{"kind":"json-schema","data":{"required":["password"],"type":"object","properties":{"password":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}}},"id":"schema_616"},"schema_617":{"kind":"json-schema","data":{"type":"object","properties":{"passwordInfo":{"type":"object","required":["buyerId"],"description":"Additional information related to the user's password.","properties":{"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The buyer to which the user's password information belongs to."},"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."}}},"token":{"type":"string","description":"The authorisation token to be used in the Authorization header for secured operations."}}},"id":"schema_617"},"schema_618":{"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_618"},"schema_619":{"kind":"json-schema","data":{"type":"object","required":["oldPassword","newPassword"],"properties":{"oldPassword":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}},"newPassword":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}}},"id":"schema_619"},"schema_620":{"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_620"},"schema_621":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"E-mail Address of the user","format":"email"}}},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["MULTIPLE_ACCOUNTS_FOUND","ACCOUNT_NOT_FOUND"]}}},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"required":["email","nonce","newPassword"],"type":"object","properties":{"nonce":{"type":"string","description":"A randomly generated one-time use code.","minLength":6,"maxLength":6,"pattern":"^[0-9]*$"},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"newPassword":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}}},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"type":"object","properties":{"token":{"type":"string","description":"An authorisation token to be used in the Authorization header for secured operations."}}},"id":"schema_624"},"schema_625":{"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"]}}},"id":"schema_625"},"schema_626":{"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"]}}},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"object","required":["verificationCode"],"properties":{"verificationCode":{"type":"string","description":"The code received by the user on the device.","minLength":6,"maxLength":6,"pattern":"^[0-9]*$"}}},"id":"schema_627"},"schema_628":{"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","ONE_CHALLENGE_LIMIT_REMAINING","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"type":"string"},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CHANNEL_NOT_SUPPORTED","CHANNEL_NOT_REGISTERED","MOBILE_NUMBER_INVALID","RETRY_IN_15SEC","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_630"},"schema_631":{"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","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"object","required":["adminUser","company","acceptedTerms","ipAddress","supportedCurrencies"],"properties":{"tag":{"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_-]+$"},"adminUser":{"type":"object","required":["name","surname","email","mobile","companyPosition"],"description":"The admin user needs to be a director or a legal representative of the buyer that is being onboarded - this user cannot be deactivated.\n\nAdmin users need to verify their email address and mobile number, as well as complete KYC as part of the Buyer's due diligence process.\n","properties":{"name":{"type":"string","maxLength":50,"description":"The first name of the admin user."},"surname":{"type":"string","maxLength":50,"description":"The last name of the admin user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"companyPosition":{"type":"string","description":"The company position of the Buyer Admin User.","enum":["DIRECTOR","AUTHORISED_REPRESENTATIVE"]},"dateOfBirth":{"type":"object","required":["year","month","day"],"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}}}}},"company":{"required":["name","type","countryOfRegistration"],"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":{"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":["LLC","PUBLIC_LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP"]},"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The company registration number."},"businessAddress":{"description":"The address where the business is based.","type":"object","required":["addressLine1","city","postCode","country"],"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":{"minLength":1,"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post cost 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."}}},"countryOfRegistration":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"],"description":"The country of company registration in ISO 3166 alpha-2."}}},"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 buyer admin user has accepted the terms and conditions."},"children":[]}]}]}]},"ipAddress":{"type":"string","maxLength":45,"minLength":5,"description":"The IP address of the buyer user doing the registration."},"supportedCurrencies":{"type":"array","minItems":1,"items":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]}}}},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"allOf":[{"required":["id","adminUser","company","acceptedTerms","creationTimestamp","supportedCurrencies"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Id of the buyer."},"tag":{"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_-]+$"},"adminUser":{"required":["id","email","name","surname","mobile","active","emailVerified","mobileNumberVerified","companyPosition","roles"],"type":"object","properties":{"id":{"allOf":[{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."},{"description":"The Corporate Id"}]},"name":{"maxLength":100,"type":"string","description":"First name of the admin user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the admin user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"companyPosition":{"type":"string","description":"The company position of the Buyer Admin User.","enum":["DIRECTOR","AUTHORISED_REPRESENTATIVE"]},"dateOfBirth":{"description":"Date of birth of the authorised user.","type":"object","required":["year","month","day"],"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}}},"active":{"type":"boolean","description":"The state of the admin user. If false, then the user will not be able to log in.","readOnly":true},"emailVerified":{"type":"boolean","description":"Indicates if the admin user's email has been verified.","readOnly":true},"mobileNumberVerified":{"type":"boolean","description":"Indicates if the admin user's mobile number has been verified.","readOnly":true},"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN","CREATOR","CONTROLLER"]}}},"description":"The admin user of the Buyer Identity."},"company":{"allOf":[{"required":["name","type","countryOfRegistration"],"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":{"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":["LLC","PUBLIC_LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP"]},"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The company registration number."},"businessAddress":{"description":"The address where the business is based.","type":"object","required":["addressLine1","city","postCode","country"],"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":{"minLength":1,"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post cost 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."}}},"countryOfRegistration":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"],"description":"The country of company registration in ISO 3166 alpha-2."}}},{"type":"object","properties":{"registeredAddress":{"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."}},"readOnly":true},"incorporatedOn":{"description":"The company's date of incorporation","type":"object","required":["year","month","day"],"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}},"readOnly":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 admin user has accepted the terms and conditions."},"children":[]}]}]}]},"supportedCurrencies":{"type":"array","items":{"type":"object","required":["currency","status"],"properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the currency, which can include the following values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_KYB_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer’s KYB process is pending approval."},"children":[]}]}]}]}],"enum":["PENDING_KYB_APPROVAL"]}}}},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the Buyer was created, expressed in Epoch timestamp using millisecond precision.","readOnly":true}}},{"type":"object","properties":{"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the user doing the registration."}}}]},"id":"schema_633"},"schema_634":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["ADMIN_EMAIL_NOT_UNIQUE","CURRENCY_UNSUPPORTED","COUNTRY_INVALID","TERMS_NOT_ACCEPTED","MOBILE_OR_COUNTRY_CODE_INVALID","COUNTRY_UNSUPPORTED","COMPANY_TYPE_UNSUPPORTED","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_634"},"schema_635":{"kind":"json-schema","data":{"allOf":[{"required":["id","adminUser","company","acceptedTerms","creationTimestamp","supportedCurrencies"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Id of the buyer."},"tag":{"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_-]+$"},"adminUser":{"required":["id","email","name","surname","mobile","active","emailVerified","mobileNumberVerified","companyPosition","roles"],"type":"object","properties":{"id":{"allOf":[{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."},{"description":"The Corporate Id"}]},"name":{"maxLength":100,"type":"string","description":"First name of the admin user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the admin user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"companyPosition":{"type":"string","description":"The company position of the Buyer Admin User.","enum":["DIRECTOR","AUTHORISED_REPRESENTATIVE"]},"dateOfBirth":{"description":"Date of birth of the authorised user.","type":"object","required":["year","month","day"],"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}}},"active":{"type":"boolean","description":"The state of the admin user. If false, then the user will not be able to log in.","readOnly":true},"emailVerified":{"type":"boolean","description":"Indicates if the admin user's email has been verified.","readOnly":true},"mobileNumberVerified":{"type":"boolean","description":"Indicates if the admin user's mobile number has been verified.","readOnly":true},"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN","CREATOR","CONTROLLER"]}}},"description":"The admin user of the Buyer Identity."},"company":{"allOf":[{"required":["name","type","countryOfRegistration"],"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":{"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":["LLC","PUBLIC_LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP"]},"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The company registration number."},"businessAddress":{"description":"The address where the business is based.","type":"object","required":["addressLine1","city","postCode","country"],"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":{"minLength":1,"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post cost 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."}}},"countryOfRegistration":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"],"description":"The country of company registration in ISO 3166 alpha-2."}}},{"type":"object","properties":{"registeredAddress":{"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."}},"readOnly":true},"incorporatedOn":{"description":"The company's date of incorporation","type":"object","required":["year","month","day"],"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}},"readOnly":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 admin user has accepted the terms and conditions."},"children":[]}]}]}]},"supportedCurrencies":{"type":"array","items":{"type":"object","required":["currency","status"],"properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the currency, which can include the following values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_KYB_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer’s KYB process is pending approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEPUP_LOGIN_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer needs to perform a stepped-up login for higher authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CREATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting the setup completion of the currency"},"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 ZBA has been successfully created and is ready for use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The currency is unavailable and cannot be used."},"children":[]}]}]}]}],"enum":["PENDING_KYB_APPROVAL","STEPUP_LOGIN_REQUIRED","PENDING_CREATION","ACTIVE","UNAVAILABLE"]}}}},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the Buyer was created, expressed in Epoch timestamp using millisecond precision.","readOnly":true}}},{"type":"object","properties":{"ipAddress":{"maxLength":45,"minLength":5,"type":"string","description":"The IP address of the user doing the registration."}}}]},"id":"schema_635"},"schema_636":{"kind":"json-schema","data":{"type":"object","properties":{"adminUser":{"type":"object","properties":{"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN","CREATOR","CONTROLLER"]}}}},"supportedCurrencies":{"type":"array","items":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]}}}},"id":"schema_636"},"schema_637":{"kind":"json-schema","data":{"required":["id","adminUser","company","acceptedTerms","creationTimestamp","supportedCurrencies"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Id of the buyer."},"tag":{"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_-]+$"},"adminUser":{"required":["id","email","name","surname","mobile","active","emailVerified","mobileNumberVerified","companyPosition","roles"],"type":"object","properties":{"id":{"allOf":[{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."},{"description":"The Corporate Id"}]},"name":{"maxLength":100,"type":"string","description":"First name of the admin user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the admin user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"companyPosition":{"type":"string","description":"The company position of the Buyer Admin User.","enum":["DIRECTOR","AUTHORISED_REPRESENTATIVE"]},"dateOfBirth":{"description":"Date of birth of the authorised user.","type":"object","required":["year","month","day"],"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}}},"active":{"type":"boolean","description":"The state of the admin user. If false, then the user will not be able to log in.","readOnly":true},"emailVerified":{"type":"boolean","description":"Indicates if the admin user's email has been verified.","readOnly":true},"mobileNumberVerified":{"type":"boolean","description":"Indicates if the admin user's mobile number has been verified.","readOnly":true},"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN","CREATOR","CONTROLLER"]}}},"description":"The admin user of the Buyer Identity."},"company":{"allOf":[{"required":["name","type","countryOfRegistration"],"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":{"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":["LLC","PUBLIC_LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP"]},"name":{"maxLength":100,"type":"string","description":"The registered name of the company."},"registrationNumber":{"maxLength":20,"minLength":1,"type":"string","description":"The company registration number."},"businessAddress":{"description":"The address where the business is based.","type":"object","required":["addressLine1","city","postCode","country"],"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":{"minLength":1,"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post cost 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."}}},"countryOfRegistration":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"],"description":"The country of company registration in ISO 3166 alpha-2."}}},{"type":"object","properties":{"registeredAddress":{"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."}},"readOnly":true},"incorporatedOn":{"description":"The company's date of incorporation","type":"object","required":["year","month","day"],"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}},"readOnly":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 admin user has accepted the terms and conditions."},"children":[]}]}]}]},"supportedCurrencies":{"type":"array","items":{"type":"object","required":["currency","status"],"properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the currency, which can include the following values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_KYB_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer’s KYB process is pending approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEPUP_LOGIN_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer needs to perform a stepped-up login for higher authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CREATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting the setup completion of the currency"},"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 ZBA has been successfully created and is ready for use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The currency is unavailable and cannot be used."},"children":[]}]}]}]}],"enum":["PENDING_KYB_APPROVAL","STEPUP_LOGIN_REQUIRED","PENDING_CREATION","ACTIVE","UNAVAILABLE"]}}}},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the Buyer was created, expressed in Epoch timestamp using millisecond precision.","readOnly":true}}},"id":"schema_637"},"schema_638":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STEP_UP_REQUIRED"]}}},"id":"schema_638"},"schema_639":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CURRENCY_UNSUPPORTED","INSUFFICIENT_PERMISSIONS"]}}},"id":"schema_639"},"schema_640":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_FOUND","ALREADY_VERIFIED","EMAIL_NOT_UNIQUE","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_640"},"schema_641":{"kind":"json-schema","data":{"type":"object","required":["email","verificationCode"],"properties":{"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"verificationCode":{"type":"string","description":"A randomly generated one-time use code used to verify the user's email address or mobile number.","minLength":6,"maxLength":6,"pattern":"^[0-9]+$"}}},"id":"schema_641"},"schema_642":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["VERIFICATION_CODE_INVALID","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_642"},"schema_643":{"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_643"},"schema_644":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["KYB_ALREADY_APPROVED","KYB_PERMANENTLY_REJECTED","KYB_PENDING_REVIEW","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"type":"object","properties":{"kybStatus":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"The effective due diligence status of the buyer that the logged-in user belongs to."},"ongoingKybStatus":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"The ongoing due diligence status of the buyer that the logged-in user belongs to."}}},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"type":"object","properties":{"tag":{"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_-]+$"},"company":{"type":"object","description":"The details associated with the company. The details provided need to match exactly with the details provided during KYB.","properties":{"businessAddress":{"description":"The address where the business is based.","type":"object","required":["addressLine1","city","postCode","country"],"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":{"minLength":1,"maxLength":50,"type":"string","description":"The city of the address."},"postCode":{"minLength":1,"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string","description":"The post cost 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."}}}}},"adminUser":{"type":"object","description":"The legal representative of the buyer. Admin users can invite and manage the buyer's authorised users.","properties":{"name":{"maxLength":100,"type":"string","description":"First name of the admin user."},"surname":{"maxLength":100,"type":"string","description":"Last name of the admin user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"dateOfBirth":{"allOf":[{"type":"object","required":["year","month","day"],"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}}},{"description":"Date of birth of the authorised user."}]}}}}},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"title":"UserCreate","required":["email","name","surname","roles"],"type":"object","properties":{"name":{"minLength":1,"maxLength":20,"type":"string","description":"The first name of the user."},"surname":{"minLength":1,"maxLength":20,"type":"string","description":"The last name of the user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"dateOfBirth":{"description":"Date of birth of the authorised user.","type":"object","required":["year","month","day"],"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}}},"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]}]}],"items":{"type":"string","enum":["CREATOR","CONTROLLER"]}}}},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"allOf":[{"required":["id","email","name","surname","buyerId","active"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user."},"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The identifier for the identity."},"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":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"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.","type":"object","required":["year","month","day"],"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}}}}},{"type":"object","required":["roles"],"properties":{"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]}]}],"items":{"type":"string","enum":["CREATOR","CONTROLLER"]}}}},{"type":"object","properties":{"addedBy":{"type":"object","required":["roleNames","userId"],"properties":{"rolesNames":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN"]}},"userId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user who added this user."}}}}}]},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_UNIQUE","MOBILE_NOT_UNIQUE","MOBILE_OR_COUNTRY_CODE_INVALID","EMAIL_DOMAIN_NOT_ALLOWED","INSUFFICIENT_PERMISSIONS","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_649"},"schema_650":{"kind":"json-schema","data":{"minimum":0,"type":"integer","format":"int32","default":0},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100},"id":"schema_651"},"schema_652":{"kind":"json-schema","data":{"type":"boolean","description":"Filter for active or deactivated users. Leave out to fetch all users."},"id":"schema_652"},"schema_653":{"kind":"json-schema","data":{"type":"string","format":"email","description":"Filter for users with the specified email address."},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"type":"object","properties":{"users":{"type":"array","description":"The list of users matching the criteria specified.","items":{"allOf":[{"required":["id","email","name","surname","buyerId","active"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user."},"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The identifier for the identity."},"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":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"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.","type":"object","required":["year","month","day"],"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}}}}},{"type":"object","required":["roles"],"properties":{"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]}]}],"items":{"type":"string","enum":["CREATOR","CONTROLLER"]}}}},{"type":"object","properties":{"addedBy":{"type":"object","required":["roleNames","userId"],"properties":{"rolesNames":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned to this role can create a business and ensure that systems and processes are effectively managed."},"children":[]}]}]}]}],"items":{"type":"string","enum":["ADMIN"]}},"userId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the user who added this 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_654"},"schema_655":{"kind":"json-schema","data":{"title":"UserUpdate","type":"object","properties":{"name":{"maxLength":20,"type":"string","description":"The first name of the user."},"surname":{"maxLength":20,"type":"string","description":"The last name of the user."},"email":{"type":"string","description":"E-mail Address of the user","format":"email"},"mobile":{"type":"object","description":"Mobile number of the user","required":["number","countryCode"],"properties":{"countryCode":{"maxLength":6,"minLength":1,"pattern":"^[\\+][0-9]{1,5}$","type":"string","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 Buyer's admin user mobile number (e.g. +44)."},"children":[]}]}]}]},"number":{"maxLength":15,"minLength":1,"pattern":"^[0-9]+$","type":"string","description":"The mobile number of the Buyer's admin user - excluding country code."}}},"dateOfBirth":{"description":"Date of birth of the authorised user.","type":"object","required":["year","month","day"],"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}}},"roles":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Roles define the level of access assigned to the user."},"children":[]}]}]},{"$$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":"CREATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can create, view and update payment runs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Users assigned this role can view and link their company's bank accounts as well as fund payment runs."},"children":[]}]}]}]}],"items":{"type":"string","enum":["CREATOR","CONTROLLER"]}}}},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_UNIQUE","MOBILE_NOT_UNIQUE","MOBILE_OR_COUNTRY_CODE_INVALID","MOBILE_NO_CHANGE_LIMIT_EXCEEDED","TOO_FREQUENT_EMAIL_CHANGES","EMAIL_DOMAIN_NOT_ALLOWED","MOBILE_CHANGE_NOT_ALLOWED","INSUFFICIENT_PERMISSIONS"]}}},"id":"schema_656"},"schema_657":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_657"},"schema_658":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVITE_ALREADY_CONSUMED","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_658"},"schema_659":{"kind":"json-schema","data":{"required":["inviteCode"],"type":"object","properties":{"inviteCode":{"type":"string","description":"A randomly generated one-time use code.","minLength":6,"maxLength":6,"pattern":"^[0-9]*$"}}},"id":"schema_659"},"schema_660":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["INVITE_OR_INVITE_CODE_INVALID","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"required":["inviteCode","password"],"type":"object","properties":{"inviteCode":{"type":"string","description":"A randomly generated one-time use code.","minLength":6,"maxLength":6,"pattern":"^[0-9]*$"},"password":{"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":"between 8 and 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":{"minLength":1,"maxLength":100,"type":"string","format":"password"}}}}},"id":"schema_661"},"schema_662":{"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","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["EMAIL_NOT_FOUND","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"type":"object","title":"PaymentRunCreate","required":["payments"],"properties":{"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"payments":{"description":"The list of payments associated with the payment run","type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}}}}}}},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"object","required":["payments","id","status","createdAt","buyerId","createdBy"],"title":"PaymentRun","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"createdBy":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672","readOnly":true},"status":{"type":"string","enum":["QUEUED"],"example":"PENDING_CONFIRMATION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the payment run."},"children":[]}]}]},{"$$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":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]}]}],"readOnly":true},"statusReason":{"type":"string"},"payments":{"type":"array","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}},"createdAt":{"type":"string","format":"date-time","readOnly":true}}},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["BANK_ACCOUNT_CANNOT_BE_LINKED_ACCOUNT","LINKED_ACCOUNT_INVALID_STATE","BANK_ACCOUNT_CANNOT_BE_ZERO_BALANCE_ACCOUNT","UNSUPPORTED_CURRENCY","INVALID_SUPPLIER_BANK_ACCOUNT_DETAILS","ZERO_BALANCE_ACCOUNT_INVALID_STATE","IDEMPOTENT_REQUEST_IN_PROGRESS","MISSING_SUPPLIER_TYPE"]}}},"id":"schema_666"},"schema_667":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","COMPLETED_WITH_ERRORS","EXECUTING","INVALID","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","SCA_FAILED"],"example":"PENDING_CONFIRMATION","description":"The status of the payment run."},"id":"schema_668"},"schema_669":{"kind":"json-schema","data":{"type":"string","description":"The unique paymentRunRef of the payment run."},"id":"schema_669"},"schema_670":{"kind":"json-schema","data":{"type":"integer","format":"int64","minimum":0,"description":"The minimum total amount of the payment run."},"id":"schema_670"},"schema_671":{"kind":"json-schema","data":{"type":"integer","format":"int64","minimum":0,"description":"The maximum total amount of the payment run."},"id":"schema_671"},"schema_672":{"kind":"json-schema","data":{"type":"object","title":"PaymentRunCollection","allOf":[{"type":"object","title":"PaginationFields","properties":{"count":{"type":"integer","description":"The total number of records (excluding the paging limit)","example":10},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","example":100}},"required":["count","responseCount"]},{"type":"object","properties":{"paymentRuns":{"type":"array","items":{"type":"object","required":["payments","id","status","createdAt","buyerId","createdBy"],"title":"PaymentRun","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"createdBy":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","COMPLETED_WITH_ERRORS","EXECUTING","INVALID","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","SCA_FAILED"],"example":"PENDING_CONFIRMATION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the payment run."},"children":[]}]}]},{"$$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":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"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":": Payment run was manually cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED_WITH_ERRORS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed and some failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds received, executing payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}],"readOnly":true},"statusReason":{"type":"string"},"payments":{"type":"array","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}},"createdAt":{"type":"string","format":"date-time","readOnly":true}}}}},"required":["paymentRuns"]}]},"id":"schema_672"},"schema_673":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"id":"schema_673"},"schema_674":{"kind":"json-schema","data":{"type":"object","required":["payments","id","status","createdAt","buyerId","createdBy"],"title":"PaymentRun","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"createdBy":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","COMPLETED_WITH_ERRORS","EXECUTING","INVALID","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","SCA_FAILED"],"example":"PENDING_CONFIRMATION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the payment run."},"children":[]}]}]},{"$$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":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"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":": Payment run was manually cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED_WITH_ERRORS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed and some failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds received, executing payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}],"readOnly":true},"statusReason":{"type":"string"},"payments":{"type":"array","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}},"createdAt":{"type":"string","format":"date-time","readOnly":true}}},"id":"schema_674"},"schema_675":{"kind":"json-schema","data":{"type":"object","required":["payments"],"properties":{"payments":{"type":"array","minItems":1,"items":{"type":"object","required":["paymentId","supplier"],"properties":{"paymentId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$"},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}}}}}}},"id":"schema_675"},"schema_676":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_RUN_INVALID_STATE","PAYMENT_RUN_DUPLICATE_PAYMENT_ID","INVALID_SUPPLIER_BANK_ACCOUNT_DETAILS","MISSING_SUPPLIER_TYPE"]}}},"id":"schema_676"},"schema_677":{"kind":"json-schema","data":{"type":"object","required":["payments","id","status","createdAt","buyerId","createdBy"],"title":"PaymentRun","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"createdBy":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672","readOnly":true},"status":{"type":"string","enum":["PENDING_CHALLENGE"],"example":"PENDING_CONFIRMATION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the payment run."},"children":[]}]}]},{"$$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_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]}]}],"readOnly":true},"statusReason":{"type":"string"},"payments":{"type":"array","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}},"createdAt":{"type":"string","format":"date-time","readOnly":true}}},"id":"schema_677"},"schema_678":{"kind":"json-schema","data":{"type":"object","required":["errorCode"],"properties":{"errorCode":{"type":"string","enum":["PAYMENT_RUN_ALREADY_CONFIRMED","BANK_ACCOUNT_CANNOT_BE_LINKED_ACCOUNT","LINKED_ACCOUNT_INVALID_STATE","ZERO_BALANCE_ACCOUNT_INVALID_STATE","IDEMPOTENT_REQUEST_IN_PROGRESS"]},"message":{"type":"string"}}},"id":"schema_678"},"schema_679":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"}},"id":"schema_679"},"schema_680":{"kind":"json-schema","data":{"type":"object","title":"PaymentRunFundingInstructions","allOf":[{"type":"object","title":"PaginationFields","properties":{"count":{"type":"integer","description":"The total number of records (excluding the paging limit)","example":10},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","example":100}},"required":["count","responseCount"]},{"type":"object","properties":{"fundingInstructions":{"type":"array","description":"One or more instructions required to fund the payment run","items":{"type":"object","required":["reference","totalAmount","status","payments"],"properties":{"reference":{"type":"string","description":"The reference to be used to initialise the PIS UX Component"},"totalAmount":{"description":"The total amount of the group of payments in the currency of the group.","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},"status":{"type":"string","description":"The status of the funding instruction","enum":["PENDING_FUNDING","AWAITING_FUNDS","CANCELLED","EXECUTING","COMPLETED","COMPLETED_WITH_ERRORS"]},"fundingDate":{"type":"string","format":"date-time","description":"The date of when the group was funded"},"payments":{"type":"array","description":"The group of payments within the payment run that are funded with this funding instruction","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}}}}}}}]},"id":"schema_680"},"schema_681":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_RUN_NOT_FOUND","TOO_MANY_LINKED_ACCOUNT_PER_CURRENCY","LINKED_ACCOUNT_NOT_FOUND","LINKED_ACCOUNT_INVALID_STATE","BANK_ACCOUNT_CANNOT_BE_LINKED_ACCOUNT","BANK_ACCOUNT_CANNOT_BE_ZERO_BALANCE_ACCOUNT","FUNDING_REQUEST_IN_PROGRESS"]}}},"id":"schema_681"},"schema_682":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CANNOT_CANCEL_PAYMENT_RUN","IDEMPOTENT_REQUEST_IN_PROGRESS"]}}},"id":"schema_682"},"schema_683":{"kind":"json-schema","data":{"type":"object","required":["paymentIds"],"properties":{"paymentIds":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"The ids of the payments to be cancelled."}}}},"id":"schema_683"},"schema_684":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["CANNOT_CANCEL_PAYMENT_RUN_PAYMENT","PAYMENT_RUN_PAYMENT_INVALID_STATE"]}}},"id":"schema_684"},"schema_685":{"kind":"json-schema","data":{"type":"object","required":["errorCode"],"properties":{"errorCode":{"type":"string","enum":["PAYMENT_RUN_INVALID_STATE"]},"message":{"type":"string"}}},"id":"schema_685"},"schema_686":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["PAYMENT_RUN_GROUP_INVALID_STATE","REFERENCE_INVALID"]}}},"id":"schema_686"},"schema_687":{"kind":"json-schema","data":{"type":"object","required":["linkedAccounts"],"properties":{"linkedAccounts":{"type":"array","items":{"type":"object","required":["id","accountIdentification","currency","institution","consent","status"],"properties":{"id":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}},"consent":{"type":"object","required":["expiresAt","expiresIn","status"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REVOKED"]}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the linked account. The status can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending challenge"},"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 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":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting a wire transfer as part of the verification process when adding an account without Open Banking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account did not pass one or more verification steps and is not eligible for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is linked and ready for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is not linked and cannot be used"},"children":[]}]}]}]}],"enum":["LINKED","UNLINKED","PENDING_CHALLENGE","PENDING_FUNDING","PENDING_VERIFICATION","REJECTED"]},"friendlyName":{"type":"string","maxLength":80,"description":"A user-friendly name for the linked account"}}}},"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_687"},"schema_688":{"kind":"json-schema","data":{"type":"object","required":["id","accountIdentification","currency","institution","consent","status"],"properties":{"id":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}},"consent":{"type":"object","required":["expiresAt","expiresIn","status"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REVOKED"]}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the linked account. The status can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending challenge"},"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 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":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting a wire transfer as part of the verification process when adding an account without Open Banking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account did not pass one or more verification steps and is not eligible for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is linked and ready for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is not linked and cannot be used"},"children":[]}]}]}]}],"enum":["LINKED","UNLINKED","PENDING_CHALLENGE","PENDING_FUNDING","PENDING_VERIFICATION","REJECTED"]},"friendlyName":{"type":"string","maxLength":80,"description":"A user-friendly name for the linked account"}}},"id":"schema_688"},"schema_689":{"kind":"json-schema","data":{"type":"object","properties":{"friendlyName":{"type":"string","maxLength":80,"nullable":false,"description":"A user-friendly name for the linked account. Allows special characters. Max 80 characters."}}},"id":"schema_689"},"schema_690":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["IDEMPOTENT_REQUEST_IN_PROGRESS","LINKED_ACCOUNT_INVALID_STATE"]}}},"id":"schema_690"},"schema_691":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_691"},"schema_692":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["EEA","UK"]}},"id":"schema_692"},"schema_693":{"kind":"json-schema","data":{"type":"integer","minimum":0},"id":"schema_693"},"schema_694":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_694"},"schema_695":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":["institutions"],"properties":{"institutions":{"type":"array","items":{"type":"object","title":"Institution","required":["id","countries"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"},"markets":{"type":"array","items":{"type":"string","enum":["EEA","UK"]}},"currencies":{"type":"array","items":{"type":"string","enum":["GBP","EUR"]}},"countries":{"type":"array","items":{"enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","properties":{"logo":{"type":"string","format":"uri"},"icon":{"type":"string","format":"uri"}}}}}}}},{"type":"object","title":"PaginationFields","properties":{"count":{"type":"integer","description":"The total number of records (excluding the paging limit)","example":10},"responseCount":{"type":"integer","description":"The total number of records returned in this response (always capped at 100).","example":100}},"required":["count","responseCount"]}]},"id":"schema_695"},"schema_696":{"kind":"json-schema","data":{"pattern":"^[0-9a-fA-F]{24}$","type":"string"},"id":"schema_696"},"schema_697":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["BUYER_ID_INVALID","UNSUPPORTED_CURRENCY"]}}},"id":"schema_697"},"schema_698":{"kind":"json-schema","data":{"type":"object","required":["buyerId","accountIdentification"],"properties":{"institutionId":{"type":"string","deprecated":true},"buyerId":{"type":"string"},"createdBy":{"type":"string","deprecated":true},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"],"deprecated":true,"default":"GBP"}}},"id":"schema_698"},"schema_699":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":["id","accountIdentification","currency","institution","consent","status"],"properties":{"id":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}},"consent":{"type":"object","required":["expiresAt","expiresIn","status"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REVOKED"]}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the linked account. The status can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending challenge"},"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 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":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting a wire transfer as part of the verification process when adding an account without Open Banking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account did not pass one or more verification steps and is not eligible for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is linked and ready for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is not linked and cannot be used"},"children":[]}]}]}]}],"enum":["LINKED","UNLINKED","PENDING_CHALLENGE","PENDING_FUNDING","PENDING_VERIFICATION","REJECTED"]},"friendlyName":{"type":"string","maxLength":80,"description":"A user-friendly name for the linked account"}}},{"type":"object","properties":{"createdAt":{"type":"string"}}}]},"id":"schema_699"},"schema_700":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["STATE_INVALID"]}}},"id":"schema_700"},"schema_701":{"kind":"json-schema","data":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["REVOKED","EXPIRED"]}}},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"type":"string","enum":["LINKED_ACCOUNT_NOT_FOUND"]}}},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"type":"object","properties":{"errorCode":{"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"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_703"},"schema_704":{"kind":"json-schema","data":{"type":"object","required":["verificationCode"],"properties":{"verificationCode":{"type":"string","minLength":1}}},"id":"schema_704"},"schema_705":{"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","PAYMENT_RUN_SCA_CHALLENGE_VERIFY_FAILED","ONE_CHALLENGE_LIMIT_REMAINING","CHALLENGE_LIMIT_EXCEEDED"]}}},"id":"schema_705"},"schema_706":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_706"},"schema_707":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["buyerKYBWatch"]},"payload":{"type":"object","properties":{"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"Id of the buyer."},"status":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Effective KYB status of the buyer."},"details":{"type":"array","description":"Action which my be required to re-process kyb in case of temporary rejections.","items":{"type":"string","enum":["BUYER_DETAILS_UNSATISFACTORY","ADMIN_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE","UNDEFINED_REQUIRED_INTERVENTION","DOCUMENTS_UNSATISFACTORY","SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH","LANGUAGE_IN_DOCUMENTS_UNSUPPORTED","SELFIE_UNSATISFACTORY","SELFIE_AND_DOCUMENTS_MISMATCH","BENEFICIARY_DETAILS_UNSATISFACTORY","REPRESENTATIVE_DETAILS_UNSATISFACTORY","OTHER","UNSUPPORTED_COUNTRY","EXPIRED_KYC_DOCUMENTS"]}},"rejectionComment":{"type":"string","description":"Reason shown to the user in case of temporary rejection."},"ongoingStatus":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Ongoing KYB Status of the buyer."}}}}},"id":"schema_707"},"schema_708":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["buyerBeneficiaryStatusWatch"]},"payload":{"type":"object","properties":{"event":{"type":"array","description":"The event that triggered this webhook notification. The event\nis structured to describe the parameter that has triggered the event followed\nby the action that occurred.\n","items":{"type":"string","enum":["STATUS_UPDATED","BENEFICIARY_TYPE_UPDATED","FIRST_NAME_UPDATED","MIDDLE_NAME_UPDATED","LAST_NAME_UPDATED","EMAIL_UPDATED"]}},"eventDetails":{"type":"array","description":"A reason, if any, describing why this event has occurred.","items":{"type":"string","enum":["BUYER_DETAILS_UNSATISFACTORY","ADMIN_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE","UNDEFINED_REQUIRED_INTERVENTION","DOCUMENTS_UNSATISFACTORY","SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH","LANGUAGE_IN_DOCUMENTS_UNSUPPORTED","SELFIE_UNSATISFACTORY","SELFIE_AND_DOCUMENTS_MISMATCH","BENEFICIARY_DETAILS_UNSATISFACTORY","REPRESENTATIVE_DETAILS_UNSATISFACTORY","OTHER","UNSUPPORTED_COUNTRY","EXPIRED_KYC_DOCUMENTS"]}},"additionalInformation":{"type":"object","properties":{"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The buyer id whose beneficiary has triggered this event."},"buyerName":{"type":"string","description":"The buyer name whose beneficiary has triggered this event."},"adminUserEmail":{"type":"string","description":"The buyer's root user email."},"kybStatus":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"The status of the Full Company Verification Checks for the buyer entity."},"beneficiary":{"type":"object","properties":{"type":{"type":"string","enum":["UNDEFINED_BENEFICIARY_TYPE","UBO","DIRECTOR","UNKNOWN","SHAREHOLDER","PARTNER","OTHER_DIRECTOR"],"description":"Type of the beneficiary."},"firstName":{"type":"string","description":"First name of the beneficiary."},"middleName":{"type":"string","description":"Middle name of the beneficiary."},"lastName":{"type":"string","description":"Last name of the beneficiary."},"email":{"type":"string","description":"Email of the beneficiary."},"status":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Effective KYB Status of the beneficiary."},"ongoingKybStatus":{"type":"string","enum":["NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Ongoing KYB Status of the beneficiary."}}}},"description":"Additional information related to the event triggering this notification."},"rejectionComment":{"type":"string","description":"Reason shown to the user in case of temporary rejection."}}}}},"id":"schema_708"},"schema_709":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["buyerActivatedWatch"]},"payload":{"required":["actionDoneBy","buyerId","supportedCurrencies"],"type":"object","properties":{"actionDoneBy":{"type":"string","enum":["UNDEFINED","ADMIN","EMBEDDER"]},"buyerId":{"type":"string"},"supportedCurrencies":{"type":"array","items":{"type":"object","required":["currency","status"],"properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the currency, which can include the following values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_KYB_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer’s KYB process is pending approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEPUP_LOGIN_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer needs to perform a stepped-up login for higher authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CREATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting the setup completion of the currency"},"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 ZBA has been successfully created and is ready for use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The currency is unavailable and cannot be used."},"children":[]}]}]}]}],"enum":["PENDING_KYB_APPROVAL","STEPUP_LOGIN_REQUIRED","PENDING_CREATION","ACTIVE","UNAVAILABLE"]}}}}}}}},"id":"schema_709"},"schema_710":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["buyerDeactivatedWatch"]},"payload":{"required":["actionDoneBy","buyerId","reasonCode","supportedCurrencies"],"type":"object","properties":{"actionDoneBy":{"type":"string","enum":["UNDEFINED","ADMIN","EMBEDDER"]},"buyerId":{"type":"string"},"reasonCode":{"type":"string","enum":["UNDEFINED_REASON","ACCOUNT_REVIEW","ACCOUNT_SECURITY","TEMPORARY","ACCOUNT_CLOSURE","ACCOUNT_ABANDONED"]},"supportedCurrencies":{"type":"array","items":{"type":"object","required":["currency","status"],"properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the currency, which can include the following values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_KYB_APPROVAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer’s KYB process is pending approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STEPUP_LOGIN_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer needs to perform a stepped-up login for higher authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CREATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting the setup completion of the currency"},"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 ZBA has been successfully created and is ready for use."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The currency is unavailable and cannot be used."},"children":[]}]}]}]}],"enum":["PENDING_KYB_APPROVAL","STEPUP_LOGIN_REQUIRED","PENDING_CREATION","ACTIVE","UNAVAILABLE"]}}}}}}}},"id":"schema_710"},"schema_711":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["paymentRunWatch"]},"payload":{"type":"object","required":["payments","id","status","createdAt","buyerId","createdBy"],"title":"PaymentRun","properties":{"id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","readOnly":true},"paymentRunRef":{"type":"string","description":"A unique identifier by which you identify the payment run with on your system.","example":"94fddfb2-297d-423d-9157-4200b7beb834"},"tag":{"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_-]+$"},"description":{"type":"string","description":"The long form description of the payment run","example":"September payment run 01"},"createdBy":{"type":"string","pattern":"^[0-9]+$","example":"110747174434373672","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","COMPLETED_WITH_ERRORS","EXECUTING","INVALID","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","SCA_FAILED"],"example":"PENDING_CONFIRMATION","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current status of the payment run."},"children":[]}]}]},{"$$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":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"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":": Payment run was manually cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED_WITH_ERRORS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All payments have been executed and some failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds received, executing payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]}],"readOnly":true},"statusReason":{"type":"string"},"payments":{"type":"array","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}},"createdAt":{"type":"string","format":"date-time","readOnly":true}}}}},"id":"schema_711"},"schema_712":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["paymentRunPaymentWatch"]},"payload":{"allOf":[{"type":"object","properties":{"paymentRunId":{"type":"string"}}},{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}]}}},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["paymentRunGroupNotFunded"]},"payload":{"allOf":[{"type":"object","properties":{"paymentRunId":{"type":"string"}}},{"type":"object","required":["reference","totalAmount","status","payments"],"properties":{"reference":{"type":"string","description":"The reference to be used to initialise the PIS UX Component"},"totalAmount":{"description":"The total amount of the group of payments in the currency of the group.","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},"status":{"type":"string","description":"The status of the funding instruction","enum":["PENDING_FUNDING","AWAITING_FUNDS","CANCELLED","EXECUTING","COMPLETED","COMPLETED_WITH_ERRORS"]},"fundingDate":{"type":"string","format":"date-time","description":"The date of when the group was funded"},"payments":{"type":"array","description":"The group of payments within the payment run that are funded with this funding instruction","items":{"type":"object","title":"Payment","required":["id","status"],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the payment line","readOnly":true},"status":{"type":"string","enum":["QUEUED","CANCELLED","COMPLETED","FAILED","PENDING_CHALLENGE","PENDING_CONFIRMATION","PENDING_FUNDING","RETURNED","AWAITING_FUNDS","EXECUTING","SCA_FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the 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":"code","inline":true,"attributes":{"content":"QUEUED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The payment run creation is an asynchronous process. This status indicates that the payment run is currently being validated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the payment run to complete the SCA challenge"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Pending until the necessary funds are initiated. Initiate the funding process via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/payment_runs/{id}/fund"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Waiting for the required funds to be available to execute payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment is being executed and awaiting final status confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment executed, but failed"},"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":": Payment cancelled, because payment run was cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CONFIRMATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run is pending confirmation by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTROLLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment sent, but was returned back"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCA_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Payment run failed due to SCA either expiring or max attempts reached. You can restart the payment run by calling the /payment_runs/{id}/restart endpoint"},"children":[]}]}]}]}],"readOnly":true}}},{"type":"object","title":"Payment","required":["amount","currency","reference","payee","paymentAmount","supplier"],"properties":{"externalRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify the associated payable on your system."},"paymentRef":{"type":"string","example":"c99cd66c-82fc-4a01-977b-61a2f5a247a1","description":"The unique identifier by which you identify this payment on your system."},"paymentAmount":{"description":"The currency and amount to be paid to the supplier.","allOf":[{"description":"The object representing a monetary amount in a particular currency","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},{"type":"object","properties":{"amount":{"type":"integer","minimum":1}}}]},"reference":{"type":"string","maxLength":18,"minLength":1,"pattern":"^[0-9a-zA-Z.-]{1,18}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The long form description of the payment. This information is also shared with the supplier. The allowed length is dependent on the payment type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":" <= 35 characters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= 18 characters"},"children":[]}]}]}]},"supplier":{"required":["bankAccountDetails","name"],"type":"object","description":"Represent the supplier bank account typically used in Outgoing Wire Transfer transactions.","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 supplier name. The allowed length and pattern is dependent on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bankAccountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SepaBankDetails"},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetails"},"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":[]}]}]}]}]},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's address."},"bankName":{"type":"string","description":"The supplier's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The supplier's bank address."},"bankCountry":{"type":"string","description":"The supplier's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"type":{"type":"string","description":"The type of supplier account. Required only when FasterPaymentsBankDetails are specified.","enum":["PERSONAL","BUSINESS"]},"bankAccountDetails":{"description":"Details of the supplier bank account, depending on the type of transfer chosen.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]}}},"validationOutcomes":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"type":"object","properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH"]},"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":"Returned when there is "},"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":[]}]}]}]}}}}}}}}]}}}}]}}},"id":"schema_713"},"schema_714":{"kind":"json-schema","data":{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["linkedAccountWatch"]},"payload":{"type":"object","title":"Linked Account Status","oneOf":[{"type":"object","required":["id","accountIdentification","currency","institution","consent","status","buyerId","userId"],"properties":{"id":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}},"consent":{"type":"object","required":["expiresAt","expiresIn","status"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REVOKED"]}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the linked account. The status can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending challenge"},"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 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":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting a wire transfer as part of the verification process when adding an account without Open Banking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account did not pass one or more verification steps and is not eligible for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is linked and ready for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is not linked and cannot be used"},"children":[]}]}]}]}],"enum":["LINKED","UNLINKED","PENDING_CHALLENGE","PENDING_FUNDING","PENDING_VERIFICATION","REJECTED"]},"friendlyName":{"type":"string","maxLength":80,"description":"A user-friendly name for the linked account"},"buyerId":{"description":"The id of the buyer that this linked account belongs to.","type":"string"},"userId":{"description":"The id of the user who initially created this linked account.","type":"string"}}},{"title":"StatusErrorDuplicatedAccount","type":"object","required":["status"],"allOf":[{"type":"object","title":"Linked Account Info","required":["accountIdentification","currency","institution"],"properties":{"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}}}},{"type":"object","properties":{"status":{"type":"string","enum":["ERROR_DUPLICATED_ACCOUNT"]}}}]},{"title":"StatusRejected","type":"object","required":["status","consent"],"properties":{"status":{"type":"string","enum":["REJECTED"]},"consent":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["REJECTED"]}}}}},{"type":"object","title":"StatusRejectedMultipleLinkedAccounts","required":["status","consent"],"properties":{"status":{"type":"string","enum":["CANNOT_LINK_MULTIPLE_ACCOUNTS"]},"consent":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["REJECTED"]}}}}}]}}},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["linkedAccountExpiringSoonWatch"]},"payload":{"type":"object","title":"Linked Account Status","oneOf":[{"type":"object","required":["id","accountIdentification","currency","institution","consent","status","buyerId","userId"],"properties":{"id":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}},"consent":{"type":"object","required":["expiresAt","expiresIn","status"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REVOKED"]}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the linked account. The status can be one of the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending challenge"},"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 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":"code","inline":true,"attributes":{"content":"PENDING_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Awaiting a wire transfer as part of the verification process when adding an account without Open Banking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account did not pass one or more verification steps and is not eligible for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is linked and ready for use"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNLINKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is not linked and cannot be used"},"children":[]}]}]}]}],"enum":["LINKED","UNLINKED","PENDING_CHALLENGE","PENDING_FUNDING","PENDING_VERIFICATION","REJECTED"]},"friendlyName":{"type":"string","maxLength":80,"description":"A user-friendly name for the linked account"},"buyerId":{"description":"The id of the buyer that this linked account belongs to.","type":"string"},"userId":{"description":"The id of the user who initially created this linked account.","type":"string"}}},{"title":"StatusErrorDuplicatedAccount","type":"object","required":["status"],"allOf":[{"type":"object","title":"Linked Account Info","required":["accountIdentification","currency","institution"],"properties":{"accountIdentification":{"description":"The bank details that uniquely identify the account on the banking systems.","oneOf":[{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}},{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}}]},"currency":{"type":"string","description":"The primary currency associated with the account","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"institution":{"type":"object","required":["countries"],"properties":{"displayName":{"description":"The name to be used when displaying the institution to users on user interfaces","type":"string"},"countries":{"type":"array","description":"The institution's supported countries","items":{"type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","enum":["GB","AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GI","GR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE"]}},"images":{"type":"object","description":"The images that should be used when displaying the institution","properties":{"icon":{"type":"string"},"logo":{"type":"string"}}},"info":{"type":"object","properties":{"loginUrl":{"type":"string"},"helplinePhoneNumber":{"type":"string"}}}}}}},{"type":"object","properties":{"status":{"type":"string","enum":["ERROR_DUPLICATED_ACCOUNT"]}}}]},{"title":"StatusRejected","type":"object","required":["status","consent"],"properties":{"status":{"type":"string","enum":["REJECTED"]},"consent":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["REJECTED"]}}}}},{"type":"object","title":"StatusRejectedMultipleLinkedAccounts","required":["status","consent"],"properties":{"status":{"type":"string","enum":["CANNOT_LINK_MULTIPLE_ACCOUNTS"]},"consent":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["REJECTED"]}}}}}]}}},"id":"schema_715"},"schema_716":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["loginWatch"]},"payload":{"required":["credential","publishedTimestamp","status","type"],"type":"object","properties":{"credential":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ROOT","USER"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}},"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The buyer id whose beneficiary has triggered this event."},"type":{"type":"string","description":"Login type can be with password or with auth/access token"},"status":{"type":"string","enum":["VERIFIED","DECLINED","EXPIRED"]},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}}},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["stepupWatch"]},"payload":{"required":["challengeId","credential","identity","publishedTimestamp","status","type"],"type":"object","properties":{"credential":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ROOT","USER"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}},"buyerId":{"type":"string","pattern":"^[0-9]+$","description":"The buyer id whose beneficiary has triggered this event."},"challengeId":{"type":"string","pattern":"^[0-9]+$"},"type":{"type":"string"},"status":{"type":"string","enum":["VERIFIED","DECLINED","EXPIRED"]},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"authToken":{"type":"string"}}}}},"id":"schema_717"},"schema_718":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string","enum":["authenticationFactorsWatch"]},"payload":{"required":["credentialId","publishedTimestamp","status","type"],"type":"object","properties":{"credential":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ROOT","USER"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}},"type":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}}},"id":"schema_718"},"schema_719":{"kind":"json-schema","data":{"type":"object","required":["type","payload"],"properties":{"type":{"type":"string","enum":["sweepingWatch"]},"payload":{"type":"object","required":["buyerId","sweepingId","transactionAmount","transactionDate","status","destination"],"properties":{"buyerId":{"type":"string","description":"Buyer id."},"sweepingId":{"type":"string","description":"Sweeping id.","example":"654cea294f19c7598987cc84"},"reference":{"type":"string","description":"Sweeping transaction reference."},"transactionDate":{"type":"string","format":"date-time","example":"2023-09-23T11:34:45Z00","description":"Date for when sweeping transaction happened"},"transactionAmount":{"description":"Sweeping transaction amount","required":["currency","amount"],"type":"object","properties":{"currency":{"type":"string","description":"The currency expressed in ISO-4217 code.","maxLength":3,"minLength":3,"enum":["GBP","EUR"]},"amount":{"type":"integer","format":"int64","example":454321,"description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a GBP currency is actually 1000 pennies or GBP 10.00.\n"}}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the sweeping 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":"SUBMITTED: Sweeping has been initiated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: Sweeping 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: Sweeping submission was approved."},"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 sweeping, 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: Sweeping has been returned to the sender"},"children":[]}]}]}]}],"enum":["SUBMITTED","REJECTED","APPROVED","FAILED","COMPLETED","RETURNED"]},"destination":{"description":"Sweeping destination bank account details","type":"object","required":["linkedAccountId","bankAccountDetails"],"properties":{"linkedAccountId":{"description":"The unique identifier of the linked account","type":"string","pattern":"^[0-9a-fA-F]{24}$","example":"652d25b73541d8084a88a38d"},"bankAccountDetails":{"description":"Details of the destination bank account, depending on the type of linked account.","oneOf":[{"title":"SepaBankDetails","required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA.","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."},"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."}}},{"title":"FasterPaymentsBankDetails","required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","minLength":8,"maxLength":8,"pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Secondary reference data if applicable."}}}]}}}}}}},"id":"schema_719"}},"exampleStore":{},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"apiKey","description":"The API Key representing your Weavr account. You can find your API Key in your Weavr Portal in the API Credentials page.","in":"header","paramName":"api-key"},"authToken":{"id":"authToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The authentication token representing the user. This will be included in the login response object."}},"servers":[{"url":"https://sandbox.weavr.io/payment-run","description":"Sandbox"},{"url":"/_mock/products/payment-run/openapi","isMockServer":true,"description":"Mock server"}],"logo":{"imageUrl":"https://weavr-cdn.s3.eu-central-1.amazonaws.com/weavr-payment-run-logo.png","altText":"Weavr","backgroundColor":"#FFFFFF"}},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/products/payment-run/openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/payment-run/openapi.json?download"},{"url":"/_bundle/products/payment-run/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Weavr Embedded Payment Run API","description":"Weavr Payment Run Plug-in API provides a simple and flexible way for Embedders to add payment execution capabilities in their application.\n\nBy integrating Weavr Payment Run plug-in API in your application, you can embed banking and payment capabilities within your app to boost productivity for your users in a seamless experience.\n\n# Authentication\nEach request to the API must include an `api_key` that represents your account. You can obtain an API Key by registering for a Embedder account [here](https://portal.weavr.io/register/?plugin=payment-run).\n\nAlmost all endpoints require a secondary authentication token `auth_token` that represents the user for whom the request is being executed.\n\n# Postman Collection\nTo help you get started with your integration, you can download the [Postman](https://postman.com) collection [here](https://sandbox.weavr.io/payment-run/v1/postman). The collection includes the steps you’ll need to follow to integrate Embedded Payment Run within your app. \n\nThe collection makes use of environment variables to pre-fill details associated with your Sandbox account, such as your account’s API Key. You can download your Sandbox Account environment file from the [Sandbox Portal](https://portal.weavr.io/register/?plugin=payment-run).\n"}},"baseSlug":"/products/payment-run/openapi","routesMapping":{}}